component-base: k8s.io/component-base/cli/flag Index | Files

package flag

import "k8s.io/component-base/cli/flag"

Index

Package Files

ciphersuites_flag.go colon_separated_multimap_string_string.go configuration_map.go flags.go langle_separated_map_string_string.go map_string_bool.go map_string_string.go namedcertkey_flag.go noop.go omitempty.go sectioned.go string_flag.go tristate.go

func DefaultTLSVersion Uses

func DefaultTLSVersion() uint16

func InitFlags Uses

func InitFlags()

InitFlags normalizes, parses, then logs the command line flags

func PrintSections Uses

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 Uses

func TLSCipherPossibleValues() []string

func TLSCipherSuites Uses

func TLSCipherSuites(cipherNames []string) ([]uint16, error)

func TLSPossibleVersions Uses

func TLSPossibleVersions() []string

func TLSVersion Uses

func TLSVersion(versionName string) (uint16, error)

func WarnWordSepNormalizeFunc Uses

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

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

func WordSepNormalizeFunc Uses

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

WordSepNormalizeFunc changes all flags that contain "_" separators

type ColonSeparatedMultimapStringString Uses

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 Uses

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 Uses

func (m *ColonSeparatedMultimapStringString) Empty() bool

Empty implements OmitEmpty

func (*ColonSeparatedMultimapStringString) Set Uses

func (m *ColonSeparatedMultimapStringString) Set(value string) error

Set implements github.com/spf13/pflag.Value

func (*ColonSeparatedMultimapStringString) String Uses

func (m *ColonSeparatedMultimapStringString) String() string

String implements github.com/spf13/pflag.Value

func (*ColonSeparatedMultimapStringString) Type Uses

func (m *ColonSeparatedMultimapStringString) Type() string

Type implements github.com/spf13/pflag.Value

type ConfigurationMap Uses

type ConfigurationMap map[string]string

func (*ConfigurationMap) Set Uses

func (m *ConfigurationMap) Set(value string) error

func (*ConfigurationMap) String Uses

func (m *ConfigurationMap) String() string

func (*ConfigurationMap) Type Uses

func (*ConfigurationMap) Type() string

type LangleSeparatedMapStringString Uses

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 Uses

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 Uses

func (m *LangleSeparatedMapStringString) Empty() bool

Empty implements OmitEmpty

func (*LangleSeparatedMapStringString) Set Uses

func (m *LangleSeparatedMapStringString) Set(value string) error

Set implements github.com/spf13/pflag.Value

func (*LangleSeparatedMapStringString) String Uses

func (m *LangleSeparatedMapStringString) String() string

String implements github.com/spf13/pflag.Value

func (*LangleSeparatedMapStringString) Type Uses

func (*LangleSeparatedMapStringString) Type() string

Type implements github.com/spf13/pflag.Value

type MapStringBool Uses

type MapStringBool struct {
    Map *map[string]bool
    // contains filtered or unexported fields
}

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 Uses

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 Uses

func (m *MapStringBool) Empty() bool

Empty implements OmitEmpty

func (*MapStringBool) Set Uses

func (m *MapStringBool) Set(value string) error

Set implements github.com/spf13/pflag.Value

func (*MapStringBool) String Uses

func (m *MapStringBool) String() string

String implements github.com/spf13/pflag.Value

func (*MapStringBool) Type Uses

func (*MapStringBool) Type() string

Type implements github.com/spf13/pflag.Value

type MapStringString Uses

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 Uses

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 Uses

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 Uses

func (m *MapStringString) Empty() bool

Empty implements OmitEmpty

func (*MapStringString) Set Uses

func (m *MapStringString) Set(value string) error

Set implements github.com/spf13/pflag.Value

func (*MapStringString) String Uses

func (m *MapStringString) String() string

String implements github.com/spf13/pflag.Value

func (*MapStringString) Type Uses

func (*MapStringString) Type() string

Type implements github.com/spf13/pflag.Value

type NamedCertKey Uses

type NamedCertKey struct {
    Names             []string
    CertFile, KeyFile string
}

NamedCertKey is a flag value parsing "certfile,keyfile" and "certfile,keyfile:name,name,name".

func (*NamedCertKey) Set Uses

func (nkc *NamedCertKey) Set(value string) error

func (*NamedCertKey) String Uses

func (nkc *NamedCertKey) String() string

func (*NamedCertKey) Type Uses

func (*NamedCertKey) Type() string

type NamedCertKeyArray Uses

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 Uses

func NewNamedCertKeyArray(p *[]NamedCertKey) *NamedCertKeyArray

NewNamedKeyCertArray creates a new NamedCertKeyArray with the internal value pointing to p.

func (*NamedCertKeyArray) Set Uses

func (a *NamedCertKeyArray) Set(val string) error

func (*NamedCertKeyArray) String Uses

func (a *NamedCertKeyArray) String() string

func (*NamedCertKeyArray) Type Uses

func (a *NamedCertKeyArray) Type() string

type NamedFlagSets Uses

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.

func (*NamedFlagSets) FlagSet Uses

func (nfs *NamedFlagSets) FlagSet(name string) *pflag.FlagSet

FlagSet returns the flag set with the given name and adds it to the ordered name list if it is not in there yet.

type NoOp Uses

type NoOp struct{}

NoOp implements goflag.Value and plfag.Value, but has a noop Set implementation

func (NoOp) Set Uses

func (NoOp) Set(val string) error

func (NoOp) String Uses

func (NoOp) String() string

func (NoOp) Type Uses

func (NoOp) Type() string

type OmitEmpty Uses

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 Uses

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 Uses

func NewStringFlag(defaultVal string) StringFlag

func (*StringFlag) Default Uses

func (f *StringFlag) Default(value string)

func (StringFlag) Provided Uses

func (f StringFlag) Provided() bool

func (*StringFlag) Set Uses

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

func (StringFlag) String Uses

func (f StringFlag) String() string

func (*StringFlag) Type Uses

func (f *StringFlag) Type() string

func (StringFlag) Value Uses

func (f StringFlag) Value() string

type Tristate Uses

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 Uses

func (f *Tristate) Default(value bool)

func (Tristate) Provided Uses

func (f Tristate) Provided() bool

func (*Tristate) Set Uses

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

func (Tristate) String Uses

func (f Tristate) String() string

func (*Tristate) Type Uses

func (f *Tristate) Type() string

func (Tristate) Value Uses

func (f Tristate) Value() bool

Package flag imports 12 packages (graph) and is imported by 179 packages. Updated 2019-06-18. Refresh now. Tools for package owners.