Documentation
¶
Overview ¶
Package flags implements command-line flag parsing.
Index ¶
- func FlagToEnv(prefix, name string) string
- func IsSet(fs *flag.FlagSet, name string) bool
- func SetFlagsFromEnv(prefix string, fs *flag.FlagSet) error
- func SetPflagsFromEnv(prefix string, fs *pflag.FlagSet) error
- func StringsFromFlagV2(fs *flag.FlagSet, flagName string) []string
- func URLsFromFlag(fs *flag.FlagSet, urlsFlagName string) []url.URL
- type DeprecatedFlag
- type IgnoredFlag
- type StringsFlag
- type StringsValueV2
- type URLsValue
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FlagToEnv ¶ added in v3.1.0
FlagToEnv converts flag string to upper-case environment variable key string.
func SetFlagsFromEnv ¶
SetFlagsFromEnv parses all registered flags in the given flagset, and if they are not already set it attempts to set their values from environment variables. Environment variables take the name of the flag but are UPPERCASE, have the given prefix and any dashes are replaced by underscores - for example: some-flag => ETCD_SOME_FLAG
func SetPflagsFromEnv ¶
SetPflagsFromEnv is similar to SetFlagsFromEnv. However, the accepted flagset type is pflag.FlagSet and it does not do any logging.
func StringsFromFlagV2 ¶ added in v3.2.22
StringsFromFlagV2 returns a string slice from the flag.
Types ¶
type DeprecatedFlag ¶
type DeprecatedFlag struct {
Name string
}
DeprecatedFlag encapsulates a flag that may have been previously valid but is now deprecated. If a DeprecatedFlag is set, an error occurs.
func (*DeprecatedFlag) Set ¶
func (f *DeprecatedFlag) Set(_ string) error
func (*DeprecatedFlag) String ¶
func (f *DeprecatedFlag) String() string
type IgnoredFlag ¶
type IgnoredFlag struct {
Name string
}
IgnoredFlag encapsulates a flag that may have been previously valid but is now ignored. If an IgnoredFlag is set, a warning is printed and operation continues.
func (*IgnoredFlag) IsBoolFlag ¶
func (f *IgnoredFlag) IsBoolFlag() bool
IsBoolFlag is defined to allow the flag to be defined without an argument
func (*IgnoredFlag) Set ¶
func (f *IgnoredFlag) Set(s string) error
func (*IgnoredFlag) String ¶
func (f *IgnoredFlag) String() string
type StringsFlag ¶
type StringsFlag struct {
Values []string
// contains filtered or unexported fields
}
StringsFlag implements the flag.Value interface.
func NewStringsFlag ¶
func NewStringsFlag(valids ...string) *StringsFlag
NewStringsFlag creates a new string flag for which any one of the given strings is a valid value, and any other value is an error.
func (*StringsFlag) Set ¶
func (ss *StringsFlag) Set(s string) error
Set verifies the argument to be a valid member of the allowed values before setting the underlying flag value.
func (*StringsFlag) String ¶
func (ss *StringsFlag) String() string
String returns the set value (if any) of the StringsFlag
type StringsValueV2 ¶ added in v3.2.22
type StringsValueV2 sort.StringSlice
StringsValueV2 wraps "sort.StringSlice".
func NewStringsValueV2 ¶ added in v3.2.22
func NewStringsValueV2(s string) (ss *StringsValueV2)
NewStringsValueV2 implements string slice as "flag.Value" interface. Given value is to be separated by comma.
func (*StringsValueV2) Set ¶ added in v3.2.22
func (ss *StringsValueV2) Set(s string) error
Set parses a command line set of strings, separated by comma. Implements "flag.Value" interface.
func (*StringsValueV2) String ¶ added in v3.2.22
func (ss *StringsValueV2) String() string
String implements "flag.Value" interface.
type URLsValue ¶
func NewURLsValue ¶
func (*URLsValue) Set ¶
Set parses a command line set of URLs formatted like: http://127.0.0.1:2380,http://10.1.1.2:80
Source Files