flagutil

Documentation

Overview

Package flagutil contains flags that parse string lists and string maps.

Index

• func DualFormatBoolVar(fs *pflag.FlagSet, p *bool, name string, value bool, usage string)
• func DualFormatInt64Var(fs *pflag.FlagSet, p *int64, name string, value int64, usage string)
• func DualFormatIntVar(fs *pflag.FlagSet, p *int, name string, value int, usage string)
• func DualFormatStringListVar(fs *pflag.FlagSet, p *[]string, name string, value []string, usage string)
• func DualFormatStringVar(fs *pflag.FlagSet, p *string, name string, value string, usage string)
• func StringListVar(fs *pflag.FlagSet, p *[]string, name string, defaultValue []string, ...)
• type DurationOrIntVar
  • func NewDurationOrIntVar(name string, val time.Duration, fallback time.Duration) *DurationOrIntVar
  • func (v *DurationOrIntVar) Set(s string) error
  • func (v *DurationOrIntVar) String() string
  • func (v *DurationOrIntVar) Type() string
  • func (v *DurationOrIntVar) Value() time.Duration
• type OptionalFlag
• type OptionalFloat64
  • func NewOptionalFloat64(val float64) *OptionalFloat64
  • func (f *OptionalFloat64) Get() float64
  • func (f *OptionalFloat64) IsSet() bool
  • func (f *OptionalFloat64) Set(arg string) error
  • func (f *OptionalFloat64) String() string
  • func (f *OptionalFloat64) Type() string
• type OptionalString
  • func NewOptionalString(val string) *OptionalString
  • func (f *OptionalString) Get() string
  • func (f *OptionalString) IsSet() bool
  • func (f *OptionalString) Set(arg string) error
  • func (f *OptionalString) String() string
  • func (f *OptionalString) Type() string
• type StringListValue
  • func (value StringListValue) Get() any
  • func (value *StringListValue) Set(v string) error
  • func (value StringListValue) String() string
  • func (value StringListValue) Type() string
• type StringMapValue
  • func (value StringMapValue) Get() any
  • func (value *StringMapValue) Set(v string) error
  • func (value StringMapValue) String() string
  • func (value StringMapValue) Type() string
• type StringSetFlag
  • func (set *StringSetFlag) Set(s string) error
  • func (set *StringSetFlag) String() string
  • func (set *StringSetFlag) ToSet() sets.Set[string]
  • func (set *StringSetFlag) Type() string

Functions

func DualFormatBoolVar

func DualFormatBoolVar(fs *pflag.FlagSet, p *bool, name string, value bool, usage string)

DualFormatBoolVar creates a flag which supports both dashes and underscores

func DualFormatInt64Var

func DualFormatInt64Var(fs *pflag.FlagSet, p *int64, name string, value int64, usage string)

DualFormatInt64Var creates a flag which supports both dashes and underscores

func DualFormatIntVar

func DualFormatIntVar(fs *pflag.FlagSet, p *int, name string, value int, usage string)

DualFormatIntVar creates a flag which supports both dashes and underscores

func DualFormatStringListVar

func DualFormatStringListVar(fs *pflag.FlagSet, p *[]string, name string, value []string, usage string)

DualFormatStringListVar creates a flag which supports both dashes and underscores

func DualFormatStringVar

func DualFormatStringVar(fs *pflag.FlagSet, p *string, name string, value string, usage string)

DualFormatStringVar creates a flag which supports both dashes and underscores

func StringListVar

func StringListVar(fs *pflag.FlagSet, p *[]string, name string, defaultValue []string, usage string)

StringListVar defines a []string flag with the specified name, value and usage string. The argument 'p' points to a []string in which to store the value of the flag.

Types

type DurationOrIntVar

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

DurationOrIntVar implements pflag.Value for flags that have historically been of type IntVar (and then converted to seconds or some other unit) but are now transitioning to a proper DurationVar type.

When parsing a command-line argument, it will first attempt to parse the argument using time.ParseDuration; if this fails, it will fallback to strconv.ParseInt and multiply that value by the `fallback` unit value to get a duration. If the initial ParseDuration fails, it will also log a deprecation warning.

func NewDurationOrIntVar

func NewDurationOrIntVar(name string, val time.Duration, fallback time.Duration) *DurationOrIntVar

NewDurationOrIntVar returns a new DurationOrIntVar struct with the given name, default value, and fallback unit.

The name is used only when issuing a deprecation warning (so the user knows which flag needs its argument format updated).

The `fallback` argument is used when parsing an argument as an int (legacy behavior) as the multiplier to get a time.Duration value. As an example, if a flag used to be "the amount of time to wait in seconds" with a default of 60, you would do:

myFlag := flagutil.NewDurationOrIntVar("my-flag", time.Minute /* 60 second default */, time.Second /* fallback unit to multiply by */)

func (*DurationOrIntVar) Set

func (v *DurationOrIntVar) Set(s string) error

Set is part of the pflag.Value interface.

func (*DurationOrIntVar) String

func (v *DurationOrIntVar) String() string

String is part of the pflag.Value interface.

func (*DurationOrIntVar) Type

func (v *DurationOrIntVar) Type() string

Type is part of the pflag.Type interface.

func (*DurationOrIntVar) Value

func (v *DurationOrIntVar) Value() time.Duration

Value returns the underlying Duration value passed to the flag.

type OptionalFlag

type OptionalFlag interface {
	pflag.Value
	IsSet() bool
}

OptionalFlag augements the pflag.Value interface with a method to determine if a flag was set explicitly on the comand-line.

Though not part of the interface, because the return type would be different for each implementation, by convention, each implementation should define a Get() method to access the underlying value.

TODO (ajm188) - replace this interface with a generic type. c.f. https://github.com/vitessio/vitess/issues/11154.

type OptionalFloat64

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

OptionalFloat64 implements OptionalFlag for float64 values.

func NewOptionalFloat64

func NewOptionalFloat64(val float64) *OptionalFloat64

NewOptionalFloat64 returns an OptionalFloat64 with the specified value as its starting value.

func (*OptionalFloat64) Get

func (f *OptionalFloat64) Get() float64

Get returns the underlying float64 value of this flag. If the flag was not explicitly set, this will be the initial value passed to the constructor.

func (*OptionalFloat64) IsSet

func (f *OptionalFloat64) IsSet() bool

IsSet is part of the OptionalFlag interface.

func (*OptionalFloat64) Set

func (f *OptionalFloat64) Set(arg string) error

Set is part of the pflag.Value interface.

func (*OptionalFloat64) String

func (f *OptionalFloat64) String() string

String is part of the pflag.Value interface.

func (*OptionalFloat64) Type

func (f *OptionalFloat64) Type() string

Type is part of the pflag.Value interface.

type OptionalString

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

OptionalString implements OptionalFlag for string values.

func NewOptionalString

func NewOptionalString(val string) *OptionalString

NewOptionalString returns an OptionalString with the specified value as its starting value.

func (*OptionalString) Get

func (f *OptionalString) Get() string

Get returns the underlying string value of this flag. If the flag was not explicitly set, this will be the initial value passed to the constructor.

func (*OptionalString) IsSet

func (f *OptionalString) IsSet() bool

IsSet is part of the OptionalFlag interface.

func (*OptionalString) Set

func (f *OptionalString) Set(arg string) error

Set is part of the pflag.Value interface.

func (*OptionalString) String

func (f *OptionalString) String() string

String is part of the pflag.Value interface.

func (*OptionalString) Type

func (f *OptionalString) Type() string

Type is part of the pflag.Value interface.

type StringListValue

type StringListValue []string

StringListValue is a []string flag that accepts a comma separated list of elements. To include an element containing a comma, quote it with a backslash '\'.

func (StringListValue) Get

func (value StringListValue) Get() any

Get returns the []string value of this flag.

func (*StringListValue) Set

func (value *StringListValue) Set(v string) error

Set sets the value of this flag from parsing the given string.

func (StringListValue) String

func (value StringListValue) String() string

String returns the string representation of this flag.

func (StringListValue) Type

func (value StringListValue) Type() string

type StringMapValue

type StringMapValue map[string]string

StringMapValue is a map[string]string flag. It accepts a comma-separated list of key value pairs, of the form key:value. The keys cannot contain colons.

TODO (andrew): Look into whether there's a native pflag Flag type that we can use/transition to instead.

func (StringMapValue) Get

func (value StringMapValue) Get() any

Get returns the map[string]string value of this flag.

func (*StringMapValue) Set

func (value *StringMapValue) Set(v string) error

Set sets the value of this flag from parsing the given string.

func (StringMapValue) String

func (value StringMapValue) String() string

String returns the string representation of this flag.

func (StringMapValue) Type

func (value StringMapValue) Type() string

Type is part of the pflag.Value interface.

type StringSetFlag

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

StringSetFlag can be used to collect multiple instances of a flag into a set of values.

For example, defining the following:

var x flagutil.StringSetFlag
flag.Var(&x, "foo", "")

And then specifying "-foo x -foo y -foo x", will result in a set of {x, y}.

In addition to implemnting the standard flag.Value interface, it also provides an implementation of pflag.Value, so it is usable in libraries like cobra.

func (*StringSetFlag) Set

func (set *StringSetFlag) Set(s string) error

Set is part of the pflag.Value and flag.Value interfaces.

func (*StringSetFlag) String

func (set *StringSetFlag) String() string

String is part of the pflag.Value and flag.Value interfaces.

func (*StringSetFlag) ToSet

func (set *StringSetFlag) ToSet() sets.Set[string]

ToSet returns the underlying string set, or an empty set if the underlying set is nil.

func (*StringSetFlag) Type

func (set *StringSetFlag) Type() string

Type is part of the pflag.Value interface.