Documentation
¶
Index ¶
- func DefaultTLSVersion() uint16
- func InitFlags()
- func PrintSections(w io.Writer, fss NamedFlagSets, cols int)
- func TLSCipherPossibleValues() []string
- func TLSCipherSuites(cipherNames []string) ([]uint16, error)
- func TLSPossibleVersions() []string
- func TLSVersion(versionName string) (uint16, error)
- func TerminalSize(w io.Writer) (int, int, error)
- func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
- func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
- type ColonSeparatedMultimapStringString
- type ConfigurationMap
- type LangleSeparatedMapStringString
- type MapStringBool
- type MapStringString
- type NamedCertKey
- type NamedCertKeyArray
- type NamedFlagSets
- type NoOp
- type OmitEmpty
- type StringFlag
- type Tristate
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultTLSVersion ¶ added in v1.10.6
func DefaultTLSVersion() uint16
func PrintSections ¶ added in v1.12.6
func PrintSections(w io.Writer, fss NamedFlagSets, cols int)
PrintSections prints the given names flag sets in sections, with the maximal given column number. If cols is zero, lines are not wrapped.
func TLSCipherPossibleValues ¶ added in v1.11.7
func TLSCipherPossibleValues() []string
func TLSCipherSuites ¶ added in v1.10.6
func TLSPossibleVersions ¶ added in v1.11.7
func TLSPossibleVersions() []string
func TLSVersion ¶ added in v1.10.6
func TerminalSize ¶ added in v1.12.6
TerminalSize returns the current width and height of the user's terminal. If it isn't a terminal, nil is returned. On error, zero values are returned for width and height. Usually w must be the stdout of the process. Stderr won't work.
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 ColonSeparatedMultimapStringString ¶ added in v1.9.0
type ColonSeparatedMultimapStringString struct { Multimap *map[string][]string // contains filtered or unexported fields }
ColonSeparatedMultimapStringString supports setting a map[string][]string from an encoding that separates keys from values with ':' and separates key-value pairs with ','. A key can be repeated multiple times, in which case the values are appended to a slice of strings associated with that key. Items in the list associated with a given key will appear in the order provided. For example: `a:hello,b:again,c:world,b:beautiful` results in `{"a": ["hello"], "b": ["again", "beautiful"], "c": ["world"]}` The first call to Set will clear the map before adding entries; subsequent calls will simply append to the map. This makes it possible to override default values with a command-line option rather than appending to defaults, while still allowing the distribution of key-value pairs across multiple flag invocations. For example: `--flag "a:hello" --flag "b:again" --flag "b:beautiful" --flag "c:world"` results in `{"a": ["hello"], "b": ["again", "beautiful"], "c": ["world"]}`
func NewColonSeparatedMultimapStringString ¶ added in v1.9.0
func NewColonSeparatedMultimapStringString(m *map[string][]string) *ColonSeparatedMultimapStringString
NewColonSeparatedMultimapStringString takes a pointer to a map[string][]string and returns the ColonSeparatedMultimapStringString flag parsing shim for that map.
func (*ColonSeparatedMultimapStringString) Empty ¶ added in v1.9.0
func (m *ColonSeparatedMultimapStringString) Empty() bool
Empty implements OmitEmpty
func (*ColonSeparatedMultimapStringString) Set ¶ added in v1.9.0
func (m *ColonSeparatedMultimapStringString) Set(value string) error
Set implements github.com/spf13/pflag.Value
func (*ColonSeparatedMultimapStringString) String ¶ added in v1.9.0
func (m *ColonSeparatedMultimapStringString) String() string
String implements github.com/spf13/pflag.Value
func (*ColonSeparatedMultimapStringString) Type ¶ added in v1.9.0
func (m *ColonSeparatedMultimapStringString) Type() string
Type implements github.com/spf13/pflag.Value
type ConfigurationMap ¶
func (*ConfigurationMap) Set ¶
func (m *ConfigurationMap) Set(value string) error
func (*ConfigurationMap) String ¶
func (m *ConfigurationMap) String() string
func (*ConfigurationMap) Type ¶
func (*ConfigurationMap) Type() string
type LangleSeparatedMapStringString ¶ added in v1.9.0
type LangleSeparatedMapStringString struct { Map *map[string]string // contains filtered or unexported fields }
LangleSeparatedMapStringString can be set from the command line with the format `--flag "string<string"`. Multiple comma-separated key-value pairs in a single invocation are supported. For example: `--flag "a<foo,b<bar"`. Multiple flag invocations are supported. For example: `--flag "a<foo" --flag "b<foo"`.
func NewLangleSeparatedMapStringString ¶ added in v1.9.0
func NewLangleSeparatedMapStringString(m *map[string]string) *LangleSeparatedMapStringString
NewLangleSeparatedMapStringString takes a pointer to a map[string]string and returns the LangleSeparatedMapStringString flag parsing shim for that map
func (*LangleSeparatedMapStringString) Empty ¶ added in v1.9.0
func (m *LangleSeparatedMapStringString) Empty() bool
Empty implements OmitEmpty
func (*LangleSeparatedMapStringString) Set ¶ added in v1.9.0
func (m *LangleSeparatedMapStringString) Set(value string) error
Set implements github.com/spf13/pflag.Value
func (*LangleSeparatedMapStringString) String ¶ added in v1.9.0
func (m *LangleSeparatedMapStringString) String() string
String implements github.com/spf13/pflag.Value
func (*LangleSeparatedMapStringString) Type ¶ added in v1.9.0
func (*LangleSeparatedMapStringString) Type() string
Type implements github.com/spf13/pflag.Value
type MapStringBool ¶ added in v1.9.0
MapStringBool can be set from the command line with the format `--flag "string=bool"`. Multiple comma-separated key-value pairs in a single invocation are supported. For example: `--flag "a=true,b=false"`. Multiple flag invocations are supported. For example: `--flag "a=true" --flag "b=false"`.
func NewMapStringBool ¶ added in v1.9.0
func NewMapStringBool(m *map[string]bool) *MapStringBool
NewMapStringBool takes a pointer to a map[string]string and returns the MapStringBool flag parsing shim for that map
func (*MapStringBool) Empty ¶ added in v1.9.0
func (m *MapStringBool) Empty() bool
Empty implements OmitEmpty
func (*MapStringBool) Set ¶ added in v1.9.0
func (m *MapStringBool) Set(value string) error
Set implements github.com/spf13/pflag.Value
func (*MapStringBool) String ¶ added in v1.9.0
func (m *MapStringBool) String() string
String implements github.com/spf13/pflag.Value
func (*MapStringBool) Type ¶ added in v1.9.0
func (*MapStringBool) Type() string
Type implements github.com/spf13/pflag.Value
type MapStringString ¶ added in v1.9.0
type MapStringString struct { Map *map[string]string NoSplit bool // contains filtered or unexported fields }
MapStringString can be set from the command line with the format `--flag "string=string"`. Multiple flag invocations are supported. For example: `--flag "a=foo" --flag "b=bar"`. If this is desired to be the only type invocation `NoSplit` should be set to true. Multiple comma-separated key-value pairs in a single invocation are supported if `NoSplit` is set to false. For example: `--flag "a=foo,b=bar"`.
func NewMapStringString ¶ added in v1.9.0
func NewMapStringString(m *map[string]string) *MapStringString
NewMapStringString takes a pointer to a map[string]string and returns the MapStringString flag parsing shim for that map
func NewMapStringStringNoSplit ¶ added in v1.11.7
func NewMapStringStringNoSplit(m *map[string]string) *MapStringString
NewMapStringString takes a pointer to a map[string]string and sets `NoSplit` value to `true` and returns the MapStringString flag parsing shim for that map
func (*MapStringString) Empty ¶ added in v1.9.0
func (m *MapStringString) Empty() bool
Empty implements OmitEmpty
func (*MapStringString) Set ¶ added in v1.9.0
func (m *MapStringString) Set(value string) error
Set implements github.com/spf13/pflag.Value
func (*MapStringString) String ¶ added in v1.9.0
func (m *MapStringString) String() string
String implements github.com/spf13/pflag.Value
func (*MapStringString) Type ¶ added in v1.9.0
func (*MapStringString) Type() string
Type implements github.com/spf13/pflag.Value
type NamedCertKey ¶
NamedCertKey is a flag value parsing "certfile,keyfile" and "certfile,keyfile:name,name,name".
func (*NamedCertKey) Set ¶
func (nkc *NamedCertKey) Set(value string) error
func (*NamedCertKey) String ¶
func (nkc *NamedCertKey) String() string
func (*NamedCertKey) Type ¶
func (*NamedCertKey) Type() string
type NamedCertKeyArray ¶
type NamedCertKeyArray struct {
// contains filtered or unexported fields
}
NamedCertKeyArray is a flag value parsing NamedCertKeys, each passed with its own flag instance (in contrast to comma separated slices).
func NewNamedCertKeyArray ¶
func NewNamedCertKeyArray(p *[]NamedCertKey) *NamedCertKeyArray
NewNamedKeyCertArray creates a new NamedCertKeyArray with the internal value pointing to p.
func (*NamedCertKeyArray) Set ¶
func (a *NamedCertKeyArray) Set(val string) error
func (*NamedCertKeyArray) String ¶
func (a *NamedCertKeyArray) String() string
func (*NamedCertKeyArray) Type ¶
func (a *NamedCertKeyArray) Type() string
type NamedFlagSets ¶ added in v1.12.6
type NamedFlagSets struct { // Order is an ordered list of flag set names. Order []string // FlagSets stores the flag sets by name. FlagSets map[string]*pflag.FlagSet }
NamedFlagSets stores named flag sets in the order of calling FlagSet.
type NoOp ¶ added in v1.10.6
type NoOp struct{}
NoOp implements goflag.Value and plfag.Value, but has a noop Set implementation
type OmitEmpty ¶ added in v1.9.0
type OmitEmpty interface {
Empty() bool
}
OmitEmpty is an interface for flags to report whether their underlying value is "empty." If a flag implements OmitEmpty and returns true for a call to Empty(), it is assumed that flag may be omitted from the command line.
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