flagext

package
v1.14.0-rc.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 19, 2022 License: Apache-2.0 Imports: 12 Imported by: 74

Documentation

Index

Constants

This section is empty.

Variables

View Source
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 ...Registerer)

DefaultValues initiates a set of configs (Registerers) with their defaults.

func DeprecatedFlag

func DeprecatedFlag(f *flag.FlagSet, name, message string, logger log.Logger)

DeprecatedFlag logs a warning when you try to use it.

func IgnoredFlag added in v0.6.0

func IgnoredFlag(f *flag.FlagSet, name, message string)

IgnoredFlag ignores set value, without any warning

func RegisterFlags

func RegisterFlags(rs ...Registerer)

RegisterFlags registers flags with the provided Registerers

Types

type CIDR added in v1.9.0

type CIDR struct {
	Value *net.IPNet
}

CIDR is a network CIDR.

func (*CIDR) Set added in v1.9.0

func (c *CIDR) Set(s string) error

Set implements flag.Value.

func (CIDR) String added in v1.9.0

func (c CIDR) String() string

String implements flag.Value.

type CIDRSliceCSV added in v1.9.0

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 added in v1.9.0

func (c CIDRSliceCSV) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaler.

func (*CIDRSliceCSV) Set added in v1.9.0

func (c *CIDRSliceCSV) Set(s string) error

Set implements flag.Value

func (CIDRSliceCSV) String added in v1.9.0

func (c CIDRSliceCSV) String() string

String implements flag.Value

func (*CIDRSliceCSV) UnmarshalYAML added in v1.9.0

func (c *CIDRSliceCSV) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

type DayValue

type DayValue struct {
	model.Time
	// contains filtered or unexported fields
}

DayValue is a model.Time that can be used as a flag. NB it only parses days!

func NewDayValue

func NewDayValue(t model.Time) DayValue

NewDayValue makes a new DayValue; will round t down to the nearest midnight.

func (*DayValue) IsSet

func (v *DayValue) IsSet() bool

IsSet returns true is the DayValue has been set.

func (DayValue) MarshalYAML added in v0.7.0

func (v DayValue) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaler.

func (*DayValue) Set

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

Set implements flag.Value

func (DayValue) String

func (v DayValue) String() string

String implements flag.Value

func (*DayValue) UnmarshalYAML added in v0.7.0

func (v *DayValue) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

type Registerer

type Registerer interface {
	RegisterFlags(*flag.FlagSet)
}

Registerer is a thing that can RegisterFlags

type Secret added in v0.7.0

type Secret struct {
	Value string
}

func (Secret) MarshalYAML added in v0.7.0

func (v Secret) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaler.

func (*Secret) Set added in v0.7.0

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

Set implements flag.Value

func (Secret) String added in v0.7.0

func (v Secret) String() string

String implements flag.Value

func (*Secret) UnmarshalYAML added in v0.7.0

func (v *Secret) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

type StringSlice added in v0.2.0

type StringSlice []string

StringSlice is a slice of strings that implements flag.Value

func (*StringSlice) Set added in v0.2.0

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

Set implements flag.Value

func (StringSlice) String added in v0.2.0

func (v StringSlice) String() string

String implements flag.Value

type StringSliceCSV added in v1.5.0

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 added in v1.5.0

func (v StringSliceCSV) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaler.

func (*StringSliceCSV) Set added in v1.5.0

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

Set implements flag.Value

func (StringSliceCSV) String added in v1.5.0

func (v StringSliceCSV) String() string

String implements flag.Value

func (*StringSliceCSV) UnmarshalYAML added in v1.5.0

func (v *StringSliceCSV) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

type Time added in v1.3.0

type Time time.Time

Time usable as flag or in YAML config.

func (Time) MarshalYAML added in v1.3.0

func (t Time) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaler.

func (*Time) Set added in v1.3.0

func (t *Time) Set(s string) error

Set implements flag.Value

func (Time) String added in v1.3.0

func (t Time) String() string

String implements flag.Value

func (*Time) UnmarshalYAML added in v1.3.0

func (t *Time) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

type URLValue

type URLValue struct {
	*url.URL
}

URLValue is a url.URL that can be used as a flag.

func (URLValue) MarshalYAML added in v0.7.0

func (v URLValue) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaler.

func (*URLValue) Set

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

Set implements flag.Value

func (URLValue) String

func (v URLValue) String() string

String implements flag.Value

func (*URLValue) UnmarshalYAML

func (v *URLValue) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL