Documentation
¶
Overview ¶
Package flags contains enhanced versions of spf13/pflag flag routines which will read from the environment also.
Index ¶
- func BoolP(name, shorthand string, value bool, usage string, groups string) (out *bool)
- func BoolVarP(flags *pflag.FlagSet, p *bool, name, shorthand string, value bool, ...)
- func CountP(name, shorthand string, usage string, groups string) (out *int)
- func CountVarP(flags *pflag.FlagSet, p *int, name, shorthand string, usage string, ...)
- func DurationP(name, shorthand string, value time.Duration, usage string, groups string) (out *time.Duration)
- func DurationVarP(flags *pflag.FlagSet, p *time.Duration, name, shorthand string, ...)
- func FVarP(flags *pflag.FlagSet, value pflag.Value, name, shorthand, usage string, ...)
- func Float64P(name, shorthand string, value float64, usage string, groups string) (out *float64)
- func Float64VarP(flags *pflag.FlagSet, p *float64, name, shorthand string, value float64, ...)
- func Int64P(name, shorthand string, value int64, usage string, groups string) (out *int64)
- func Int64VarP(flags *pflag.FlagSet, p *int64, name, shorthand string, value int64, ...)
- func IntP(name, shorthand string, value int, usage string, groups string) (out *int)
- func IntVarP(flags *pflag.FlagSet, p *int, name, shorthand string, value int, usage string, ...)
- func SetDefaultFromEnv(flags *pflag.FlagSet, name string)
- func StringArrayP(name, shorthand string, value []string, usage string, groups string) (out *[]string)
- func StringArrayVarP(flags *pflag.FlagSet, p *[]string, name, shorthand string, value []string, ...)
- func StringP(name, shorthand string, value string, usage string, groups string) (out *string)
- func StringVarP(flags *pflag.FlagSet, p *string, name, shorthand string, value string, ...)
- func Uint32VarP(flags *pflag.FlagSet, p *uint32, name, shorthand string, value uint32, ...)
- func VarP(value pflag.Value, name, shorthand, usage string, groups string)
- type Group
- type Groups
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BoolP ¶
BoolP defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.BoolP
func BoolVarP ¶
func BoolVarP(flags *pflag.FlagSet, p *bool, name, shorthand string, value bool, usage string, groups string)
BoolVarP defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.BoolVarP
func CountP ¶
CountP defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.CountP
func CountVarP ¶
CountVarP defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.CountVarP
func DurationP ¶
func DurationP(name, shorthand string, value time.Duration, usage string, groups string) (out *time.Duration)
DurationP defines a flag which can be set by an environment variable
It wraps the duration in an fs.Duration for extra suffixes and passes it to pflag.VarP
func DurationVarP ¶
func DurationVarP(flags *pflag.FlagSet, p *time.Duration, name, shorthand string, value time.Duration, usage string, groups string)
DurationVarP defines a flag which can be set by an environment variable
It wraps the duration in an fs.Duration for extra suffixes and passes it to pflag.VarP
func FVarP ¶
FVarP defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.VarP
func Float64P ¶
Float64P defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.Float64P
func Float64VarP ¶
func Float64VarP(flags *pflag.FlagSet, p *float64, name, shorthand string, value float64, usage string, groups string)
Float64VarP defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.Float64VarP
func Int64P ¶
Int64P defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.IntP
func Int64VarP ¶ added in v1.6.1
func Int64VarP(flags *pflag.FlagSet, p *int64, name, shorthand string, value int64, usage string, groups string)
Int64VarP defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.Int64VarP
func IntP ¶
IntP defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.IntP
func IntVarP ¶
func IntVarP(flags *pflag.FlagSet, p *int, name, shorthand string, value int, usage string, groups string)
IntVarP defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.IntVarP
func SetDefaultFromEnv ¶ added in v1.56.0
SetDefaultFromEnv constructs a name from the flag passed in and sets the default from the environment if possible
Used to create backend flags like --skip-links
func StringArrayP ¶
func StringArrayP(name, shorthand string, value []string, usage string, groups string) (out *[]string)
StringArrayP defines a flag which can be set by an environment variable
It sets one value only - command line flags can be used to set more.
It is a thin wrapper around pflag.StringArrayP
func StringArrayVarP ¶
func StringArrayVarP(flags *pflag.FlagSet, p *[]string, name, shorthand string, value []string, usage string, groups string)
StringArrayVarP defines a flag which can be set by an environment variable
It sets one value only - command line flags can be used to set more.
It is a thin wrapper around pflag.StringArrayVarP
func StringP ¶
StringP defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.StringP
func StringVarP ¶
func StringVarP(flags *pflag.FlagSet, p *string, name, shorthand string, value string, usage string, groups string)
StringVarP defines a flag which can be set by an environment variable
It is a thin wrapper around pflag.StringVarP
Types ¶
type Groups ¶ added in v1.62.1
type Groups struct {
// Groups of flags
Groups []*Group
// GroupsMaps maps a group name to a Group
ByName map[string]*Group
}
Groups of Flags
var All *Groups
All is the global stats Groups
func NewGroups ¶ added in v1.62.1
func NewGroups() *Groups
NewGroups constructs a collection of Groups
func (*Groups) AllRegistered ¶ added in v1.62.1
AllRegistered returns all flags in a group
Source Files