flags

Documentation

Overview

Package flags provides custom flag value types.

Index

• type Param
• type Params
  • func ParseParams(s string) (Params, error)
  • func (p Params) Map() map[string]string
  • func (p *Params) Set(s string) error
  • func (p Params) String() string
• type Strings
  • func (a *Strings) Set(s string) error
  • func (a Strings) String() string
• type TypeParams
  • func ParseTypeParams(s string) (*TypeParams, error)
  • func (t *TypeParams) Set(s string) error
  • func (t *TypeParams) String() string

Types

type Param

type Param struct {
	Key   string
	Value string
}

Param is a key-value pair.

type Params

type Params []Param

Params is a collection of key value pairs. Satisfies the flag.Value interface.

func ParseParams

func ParseParams(s string) (Params, error)

ParseParams parses a string into a key-value pair map. Expects a comma-separated list of key-value pairs, for example:

a=1,b=2,c=3

func (Params) Map

func (p Params) Map() map[string]string

func (*Params) Set

func (p *Params) Set(s string) error

func (Params) String

func (p Params) String() string

type Strings

type Strings []string

Strings is a list of strings satisfying the flag.Value interface.

func (*Strings) Set

func (a *Strings) Set(s string) error

Set splits the comma-separated string s.

func (Strings) String

func (a Strings) String() string

type TypeParams

type TypeParams struct {
	Type   string
	Params Params
}

TypeParams is a concise configuration of some object, with a type and parameters. Satisfies the flag.Value interface.

func ParseTypeParams

func ParseTypeParams(s string) (*TypeParams, error)

ParseTypeParams parses a string into type and parameters. For example:

type:a=1,b=2,c=3

func (*TypeParams) Set

func (t *TypeParams) Set(s string) error

func (*TypeParams) String

func (t *TypeParams) String() string