flagvar

Documentation

Index

• Variables
• type Enum
  • func (e *Enum) Help() string
  • func (e *Enum) Set(v string) error
  • func (e *Enum) String() string
• type File
  • func (f *File) Help() string
  • func (f *File) Set(v string) error
  • func (f *File) String() string
  • func (f *File) Type() string
• type TCPAddr
  • func (t *TCPAddr) Help() string
  • func (t *TCPAddr) Set(v string) error
  • func (t *TCPAddr) String() string
  • func (t *TCPAddr) Type() string

Variables

var ErrInvalidEnum = errors.New("invalid enum option")

Types

type Enum

type Enum struct {
	Choices []string
	Value   string
}

func (*Enum) Help

func (e *Enum) Help() string

func (*Enum) Set

func (e *Enum) Set(v string) error

func (*Enum) String

func (e *Enum) String() string

type File

type File struct {
	Value string
}

File is a flag.Value for file paths. Returns any errors from os.Stat.

func (*File) Help

func (f *File) Help() string

Help returns a string to include in the flag's help message.

func (*File) Set

func (f *File) Set(v string) error

Set implements flag.Value by checking for the file's existence through using os.Stat. Any error returned by os.Stat is returned by this function.

func (*File) String

func (f *File) String() string

String implements flag.Value by returning the current file path.

func (*File) Type

func (f *File) Type() string

Type implements pflag.Value by noting our Value is string typed.

type TCPAddr

type TCPAddr struct {
	Network string
	Value   *net.TCPAddr
	Text    string
}

TCPAddr is a flag.Value for file paths. Returns any errors from net.ResolveTCPAddr.

func (*TCPAddr) Help

func (t *TCPAddr) Help() string

Help returns a string to include in the flag's help message.

func (*TCPAddr) Set

func (t *TCPAddr) Set(v string) error

Set implements flag.Value by parsing the provided address using net.ResolveTCPAddr. Any error return is returned by this function.

func (*TCPAddr) String

func (t *TCPAddr) String() string

String implements flag.Value by returning the current Text.

func (*TCPAddr) Type

func (t *TCPAddr) Type() string

Type implements pflag.Value by noting our Value is net.TCPAddr typed.