flagext

package
v0.0.0-...-ba97115 Latest Latest
Warning

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

Go to latest
Published: Nov 16, 2026 License: Apache-2.0 Imports: 17 Imported by: 437

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 ...interface{})

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 FlagToEnvVar

func FlagToEnvVar(prefix, flagName string) string

FlagToEnvVar converts a flag name to its corresponding environment variable name. The flag name is uppercased and all dots, dashes, and underscores in the flag name are replaced with (or kept as) underscores. The prefix is similarly upper-cased with symbol substitution. If prefix is non-empty, an _ is placed between the flag name and prefix

Note that distinct flag names can map to the same environment variable. For example, "a.b" and "a-b" both map to "A_B". Callers should avoid registering flags whose names differ only in dots, dashes, and underscores.

For example, FlagToEnvVar("myapp-name", "server.http-listen-port") returns "MYAPP_NAME_SERVER_HTTP_LISTEN_PORT".

func IgnoredFlag

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

IgnoredFlag ignores set value, without any warning

func ParseFlagsAndArguments

func ParseFlagsAndArguments(f *flag.FlagSet) ([]string, error)

ParseFlagsAndArguments calls Parse() on the input flag.FlagSet and returns the parsed arguments.

func ParseFlagsAndArgumentsWithEnv

func ParseFlagsAndArgumentsWithEnv(f *flag.FlagSet, prefix string) ([]string, error)

ParseFlagsAndArgumentsWithEnv is like ParseFlagsAndArguments but also sets flag values from environment variables using SetFlagsFromEnv. CLI flags take precedence over environment variables, which take precedence over default values.

func ParseFlagsWithoutArguments

func ParseFlagsWithoutArguments(f *flag.FlagSet) error

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 ParseFlagsWithoutArgumentsWithEnv

func ParseFlagsWithoutArgumentsWithEnv(f *flag.FlagSet, prefix string) error

ParseFlagsWithoutArgumentsWithEnv is like ParseFlagsWithoutArguments but also sets flag values from environment variables using SetFlagsFromEnv. CLI flags take precedence over environment variables, which take precedence over default values.

func RegisterFlags

func RegisterFlags(rs ...Registerer)

RegisterFlags registers flags with the provided Registerers

func RegisterFlagsWithLogger

func RegisterFlagsWithLogger(logger log.Logger, rs ...interface{})

RegisterFlagsWithLogger registers flags with the provided Registerers

func SetFlagsFromEnv

func SetFlagsFromEnv(f *flag.FlagSet, prefix string) error

SetFlagsFromEnv sets flag values from environment variables for any flags that were not explicitly set on the command line. It must be called after f.Parse() so that explicitly-set CLI flags can be detected.

The environment variable name for each flag is derived by FlagToEnvVar. CLI flags always take precedence over environment variables, and environment variables take precedence over default values.

func SetFlagsFromEnvWithLookup

func SetFlagsFromEnvWithLookup(f *flag.FlagSet, prefix string, lookup func(string) (string, bool)) error

SetFlagsFromEnvWithLookup is like SetFlagsFromEnv but uses the provided lookup function instead of os.LookupEnv. This is useful for testing or for providing an alternative source of configuration values.

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 (b Bytes) MarshalYAML() (interface{}, error)

func (*Bytes) Set

func (b *Bytes) Set(s string) error

Set implements flag.Value

func (*Bytes) String

func (b *Bytes) String() string

String implements flag.Value

func (*Bytes) UnmarshalYAML

func (b *Bytes) UnmarshalYAML(unmarshal func(interface{}) error) error

type CIDR

type CIDR struct {
	Value *net.IPNet
}

CIDR is a network CIDR.

func (*CIDR) Set

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

Set implements flag.Value.

func (CIDR) String

func (c CIDR) String() string

String implements flag.Value.

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) Set

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

Set implements flag.Value

func (CIDRSliceCSV) String

func (c CIDRSliceCSV) String() string

String implements flag.Value

func (*CIDRSliceCSV) UnmarshalYAML

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

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

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

UnmarshalYAML implements yaml.Unmarshaler.

type LimitsMap

type LimitsMap[T float64 | int | string] struct {
	// contains filtered or unexported fields
}

LimitsMap is a flag.Value implementation that looks like a generic map, holding float64s, ints, or strings as values.

func NewLimitsMap

func NewLimitsMap[T float64 | int | string](validator func(k string, v T) error) LimitsMap[T]

func NewLimitsMapWithData

func NewLimitsMapWithData[T float64 | int | string](data map[string]T, validator func(k string, v T) error) LimitsMap[T]

func (LimitsMap[T]) Clone

func (m LimitsMap[T]) Clone() LimitsMap[T]

Clone returns a copy of the LimitsMap.

func (LimitsMap[T]) Equal

func (m LimitsMap[T]) Equal(other LimitsMap[T]) bool

Equal compares two LimitsMap. This is needed to allow cmp.Equal to compare two LimitsMap.

func (LimitsMap[T]) IsInitialized

func (m LimitsMap[T]) IsInitialized() bool

IsInitialized returns true if the map is initialized.

func (LimitsMap[T]) MarshalYAML

func (m LimitsMap[T]) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaler.

func (LimitsMap[T]) Read

func (m LimitsMap[T]) Read() map[string]T

func (LimitsMap[T]) Set

func (m LimitsMap[T]) Set(s string) error

Set implements flag.Value

func (LimitsMap[T]) String

func (m LimitsMap[T]) String() string

String implements flag.Value

func (LimitsMap[T]) UnmarshalYAML

func (m LimitsMap[T]) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML implements yaml.Unmarshaler.

type RegisteredFlags

type RegisteredFlags struct {
	// Prefix is the prefix used by the flag
	Prefix string
	// Flags are the flag definitions of each one of the flag names. Flag names don't contain the prefix here.
	Flags map[string]*flag.Flag
}

RegisteredFlags contains the flags registered by some config.

func TrackRegisteredFlags

func TrackRegisteredFlags(prefix string, f *flag.FlagSet, register func(prefix string, f *flag.FlagSet)) RegisteredFlags

TrackRegisteredFlags returns the flags that were registered by the register function. It only tracks the flags that have the given prefix.

type RegisteredFlagsTracker

type RegisteredFlagsTracker interface {
	RegisteredFlags() RegisteredFlags
}

RegisteredFlagsTracker is an interface that allows to extract RegisteredFlags.

type Registerer

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

Registerer is a thing that can RegisterFlags

type RegistererWithLogger

type RegistererWithLogger interface {
	RegisterFlags(*flag.FlagSet, log.Logger)
}

RegistererWithLogger is a thing that can RegisterFlags with a Logger

type Secret

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

func SecretWithValue

func SecretWithValue(v string) Secret

SecretWithValue returns Secret with specified value.

func (Secret) Equal

func (v Secret) Equal(other Secret) bool

Equal implements go-cmp equality.

func (Secret) MarshalYAML

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

MarshalYAML implements yaml.Marshaler.

func (*Secret) Set

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

Set implements flag.Value

func (Secret) String

func (v Secret) String() string

String implements flag.Value

func (*Secret) UnmarshalYAML

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

UnmarshalYAML implements yaml.Unmarshaler.

type StringSlice

type StringSlice []string

StringSlice is a slice of strings that implements flag.Value

func (*StringSlice) Set

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

Set implements flag.Value

func (StringSlice) String

func (v StringSlice) String() string

String 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) Set

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

Set implements flag.Value

func (StringSliceCSV) String

func (v StringSliceCSV) String() string

String implements flag.Value

func (*StringSliceCSV) UnmarshalYAML

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

UnmarshalYAML implements yaml.Unmarshaler.

type StringSliceCSVMulti

type StringSliceCSVMulti []string

StringSliceCSVMulti is a slice of strings that supports both: - Multiple flag invocations (values are appended) - Comma-separated values (split on commas) It implements flag.Value

func (StringSliceCSVMulti) MarshalYAML

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

MarshalYAML implements yaml.Marshaler.

func (*StringSliceCSVMulti) Set

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

Set implements flag.Value

func (StringSliceCSVMulti) String

func (v StringSliceCSVMulti) String() string

String implements flag.Value

func (*StringSliceCSVMulti) UnmarshalYAML

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

UnmarshalYAML implements yaml.Unmarshaler.

type Time

type Time time.Time

Time usable as flag or in YAML config.

func (Time) MarshalYAML

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

MarshalYAML implements yaml.Marshaler.

func (*Time) Set

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

Set implements flag.Value

func (Time) String

func (t Time) String() string

String implements flag.Value

func (*Time) UnmarshalYAML

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

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
⌂ 换网址