flag

Documentation

Index

• func InitFlags()
• func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
• func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
• type StringFlag
  • func NewStringFlag(defaultVal string) StringFlag
  • func (f *StringFlag) Default(value string)
  • func (f StringFlag) Provided() bool
  • func (f *StringFlag) Set(value string) error
  • func (f StringFlag) String() string
  • func (f *StringFlag) Type() string
  • func (f StringFlag) Value() string
• type Tristate
  • func (f *Tristate) Default(value bool)
  • func (f Tristate) Provided() bool
  • func (f *Tristate) Set(value string) error
  • func (f Tristate) String() string
  • func (f *Tristate) Type() string
  • func (f Tristate) Value() bool

Functions

func InitFlags

func InitFlags()

InitFlags normalizes and parses the command line flags

func WarnWordSepNormalizeFunc

func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName

WarnWordSepNormalizeFunc changes and warns for flags that contain "_" separators

func WordSepNormalizeFunc

func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName

WordSepNormalizeFunc changes all flags that contain "_" separators

Types

type StringFlag

type StringFlag struct {
	// contains filtered or unexported fields
}

StringFlag is a string flag compatible with flags and pflags that keeps track of whether it had a value supplied or not.

func NewStringFlag

func NewStringFlag(defaultVal string) StringFlag

func (*StringFlag) Default

func (f *StringFlag) Default(value string)

func (StringFlag) Provided

func (f StringFlag) Provided() bool

func (*StringFlag) Set

func (f *StringFlag) Set(value string) error

func (StringFlag) String

func (f StringFlag) String() string

func (*StringFlag) Type

func (f *StringFlag) Type() string

func (StringFlag) Value

func (f StringFlag) Value() string

type Tristate

type Tristate int

Tristate is a flag compatible with flags and pflags that keeps track of whether it had a value supplied or not.

const (
	Unset Tristate = iota // 0
	True
	False
)

func (*Tristate) Default

func (f *Tristate) Default(value bool)

func (Tristate) Provided

func (f Tristate) Provided() bool

func (*Tristate) Set

func (f *Tristate) Set(value string) error

func (Tristate) String

func (f Tristate) String() string

func (*Tristate) Type

func (f *Tristate) Type() string

func (Tristate) Value

func (f Tristate) Value() bool