flags

Documentation

Index

• Constants
• Variables
• func SetFlagsFromEnv(fs *flag.FlagSet)
• func URLsFromFlags(fs *flag.FlagSet, urlsFlagName string, addrFlagName string, ...) ([]url.URL, error)
• func UsageWithIgnoredFlagsFunc(fs *flag.FlagSet, ignore []string) func()
• type DeprecatedFlag
  • func (f *DeprecatedFlag) Set(_ string) error
  • func (f *DeprecatedFlag) String() string
• type IPAddressPort
  • func (a *IPAddressPort) Set(arg string) error
  • func (a *IPAddressPort) String() string
• type IgnoredFlag
  • func (f *IgnoredFlag) IsBoolFlag() bool
  • func (f *IgnoredFlag) Set(s string) error
  • func (f *IgnoredFlag) String() string
• type Proxy
  • func (pf *Proxy) Set(s string) error
  • func (pf *Proxy) String() string
• type URLsValue
  • func NewURLsValue(init string) *URLsValue
  • func (us *URLsValue) Set(s string) error
  • func (us *URLsValue) String() string

Constants

const (
	ProxyValueOff      = "off"
	ProxyValueReadonly = "readonly"
	ProxyValueOn       = "on"
)

Variables

var (
	ProxyValues = []string{
		ProxyValueOff,
		ProxyValueReadonly,
		ProxyValueOn,
	}
)

Functions

func SetFlagsFromEnv

func SetFlagsFromEnv(fs *flag.FlagSet)

SetFlagsFromEnv parses all registered flags in the given flagset, and if they are not already set it attempts to set their values from environment variables. Environment variables take the name of the flag but are UPPERCASE, have the prefix "ETCD_", and any dashes are replaced by underscores - for example: some-flag => ETCD_SOME_FLAG

func URLsFromFlags

func URLsFromFlags(fs *flag.FlagSet, urlsFlagName string, addrFlagName string, tlsInfo transport.TLSInfo) ([]url.URL, error)

URLsFromFlags decides what URLs should be using two different flags as datasources. The first flag's Value must be of type URLs, while the second must be of type IPAddressPort. If both of these flags are set, an error will be returned. If only the first flag is set, the underlying url.URL objects will be returned unmodified. If the second flag happens to be set, the underlying IPAddressPort will be converted to a url.URL and returned. The Scheme of the returned url.URL will be http unless the provided TLSInfo object is non-empty. If neither of the flags have been explicitly set, the default value of the first flag will be returned unmodified.

func UsageWithIgnoredFlagsFunc

func UsageWithIgnoredFlagsFunc(fs *flag.FlagSet, ignore []string) func()

Types

type DeprecatedFlag

type DeprecatedFlag struct {
	Name string
}

DeprecatedFlag encapsulates a flag that may have been previously valid but is now deprecated. If a DeprecatedFlag is set, an error occurs.

func (*DeprecatedFlag) Set

func (f *DeprecatedFlag) Set(_ string) error

func (*DeprecatedFlag) String

func (f *DeprecatedFlag) String() string

type IPAddressPort

type IPAddressPort struct {
	IP   string
	Port int
}

IPAddressPort implements the flag.Value interface. The argument is validated as "ip:port".

func (*IPAddressPort) Set

func (a *IPAddressPort) Set(arg string) error

func (*IPAddressPort) String

func (a *IPAddressPort) String() string

type IgnoredFlag

type IgnoredFlag struct {
	Name string
}

IgnoredFlag encapsulates a flag that may have been previously valid but is now ignored. If an IgnoredFlag is set, a warning is printed and operation continues.

func (*IgnoredFlag) IsBoolFlag

func (f *IgnoredFlag) IsBoolFlag() bool

IsBoolFlag is defined to allow the flag to be defined without an argument

func (*IgnoredFlag) Set

func (f *IgnoredFlag) Set(s string) error

func (*IgnoredFlag) String

func (f *IgnoredFlag) String() string

type Proxy

type Proxy string

ProxyFlag implements the flag.Value interface.

func (*Proxy) Set

func (pf *Proxy) Set(s string) error

Set verifies the argument to be a valid member of proxyFlagValues before setting the underlying flag value.

func (*Proxy) String

func (pf *Proxy) String() string

type URLsValue

type URLsValue types.URLs

func NewURLsValue

func NewURLsValue(init string) *URLsValue

func (*URLsValue) Set

func (us *URLsValue) Set(s string) error

Set parses a command line set of URLs formatted like: http://127.0.0.1:7001,http://10.1.1.2:80

func (*URLsValue) String

func (us *URLsValue) String() string