Documentation
¶
Index ¶
- Variables
- func DefaultValues(rs ...interface{})
- func DeprecatedFlag(f *flag.FlagSet, name, message string, logger log.Logger)
- func IgnoredFlag(f *flag.FlagSet, name, message string)
- func ParseFlagsAndArguments(f *flag.FlagSet) ([]string, error)
- func ParseFlagsWithoutArguments(f *flag.FlagSet) error
- func RegisterFlags(rs ...Registerer)
- func RegisterFlagsWithLogger(logger log.Logger, rs ...interface{})
- type Bytes
- type CIDR
- type CIDRSliceCSV
- type DayValue
- type Registerer
- type RegistererWithLogger
- type Secret
- type StringSlice
- type StringSliceCSV
- type Time
- type URLValue
Constants ¶
This section is empty.
Variables ¶
var DeprecatedFlagsUsed = promauto.NewCounter( prometheus.CounterOpts{ Name: "deprecated_flags_inuse_total", Help: "The number of deprecated flags currently set.", })
DeprecatedFlagsUsed is the metric that counts deprecated flags set.
Functions ¶
func DefaultValues ¶
func DefaultValues(rs ...interface{})
DefaultValues initiates a set of configs (Registerers) with their defaults.
func DeprecatedFlag ¶
DeprecatedFlag logs a warning when you try to use it.
func IgnoredFlag ¶
IgnoredFlag ignores set value, without any warning
func ParseFlagsAndArguments ¶
ParseFlagsAndArguments calls Parse() on the input flag.FlagSet and returns the parsed arguments.
func ParseFlagsWithoutArguments ¶
ParseFlagsWithoutArguments calls Parse() on the input flag.FlagSet and enforces no arguments have been parsed. This utility should be called whenever we only expect CLI flags but no arguments.
func RegisterFlags ¶
func RegisterFlags(rs ...Registerer)
RegisterFlags registers flags with the provided Registerers
func RegisterFlagsWithLogger ¶
RegisterFlagsWithLogger registers flags with the provided Registerers
Types ¶
type Bytes ¶
type Bytes uint64
Bytes is a data type which supports use as a flag and yaml serialization/deserialization with units.
func (Bytes) MarshalYAML ¶
func (*Bytes) UnmarshalYAML ¶
type CIDRSliceCSV ¶
type CIDRSliceCSV []CIDR
CIDRSliceCSV is a slice of CIDRs that is parsed from a comma-separated string. It implements flag.Value and yaml Marshalers.
func (CIDRSliceCSV) MarshalYAML ¶
func (c CIDRSliceCSV) MarshalYAML() (interface{}, error)
MarshalYAML implements yaml.Marshaler.
func (*CIDRSliceCSV) UnmarshalYAML ¶
func (c *CIDRSliceCSV) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements yaml.Unmarshaler.
type DayValue ¶
DayValue is a model.Time that can be used as a flag. NB it only parses days!
func NewDayValue ¶
NewDayValue makes a new DayValue; will round t down to the nearest midnight.
func (DayValue) MarshalYAML ¶
MarshalYAML implements yaml.Marshaler.
func (*DayValue) UnmarshalYAML ¶
UnmarshalYAML implements yaml.Unmarshaler.
type Registerer ¶
Registerer is a thing that can RegisterFlags
type RegistererWithLogger ¶
RegistererWithLogger is a thing that can RegisterFlags with a Logger
type Secret ¶
type Secret struct {
// contains filtered or unexported fields
}
func SecretWithValue ¶
SecretWithValue returns Secret with specified value.
func (Secret) MarshalYAML ¶
MarshalYAML implements yaml.Marshaler.
func (*Secret) UnmarshalYAML ¶
UnmarshalYAML implements yaml.Unmarshaler.
type StringSlice ¶
type StringSlice []string
StringSlice is a slice of strings that implements flag.Value
type StringSliceCSV ¶
type StringSliceCSV []string
StringSliceCSV is a slice of strings that is parsed from a comma-separated string It implements flag.Value and yaml Marshalers
func (StringSliceCSV) MarshalYAML ¶
func (v StringSliceCSV) MarshalYAML() (interface{}, error)
MarshalYAML implements yaml.Marshaler.
func (*StringSliceCSV) UnmarshalYAML ¶
func (v *StringSliceCSV) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements yaml.Unmarshaler.
type Time ¶
Time usable as flag or in YAML config.
func (Time) MarshalYAML ¶
MarshalYAML implements yaml.Marshaler.
func (*Time) UnmarshalYAML ¶
UnmarshalYAML implements yaml.Unmarshaler.
type URLValue ¶
URLValue is a url.URL that can be used as a flag.
func (URLValue) MarshalYAML ¶
MarshalYAML implements yaml.Marshaler.
func (*URLValue) UnmarshalYAML ¶
UnmarshalYAML implements yaml.Unmarshaler.
Source Files