Documentation
¶
Index ¶
- func IsSecretFlag(s string) bool
- func ParseBytes(value string) (int64, error)
- func ParseJSONMap(s string) (map[string]string, error)
- func RegisterSecretFlag(flagName string)
- func Usage(s string)
- func WriteFlags(w io.Writer)
- type ArrayBool
- type ArrayBytes
- type ArrayDuration
- type ArrayInt
- type ArrayString
- type Bytes
- type DictInt
- type Password
- type RetentionDuration
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsSecretFlag ¶
IsSecretFlag returns true of s contains flag name with secret value, which shouldn't be exposed.
func ParseBytes ¶
ParseBytes returns int64 in bytes of parsed string with unit suffix
func ParseJSONMap ¶
ParseJSONMap parses s, which must contain JSON map of {"k1":"v1",...,"kN":"vN"}
func RegisterSecretFlag ¶
func RegisterSecretFlag(flagName string)
RegisterSecretFlag registers flagName as secret.
This function must be called before starting logging. It cannot be called from concurrent goroutines.
Secret flags aren't exported at `/metrics` page.
Types ¶
type ArrayBool ¶
type ArrayBool []bool
ArrayBool is a flag that holds an array of booleans values.
Has the same api as ArrayString.
func NewArrayBool ¶
NewArrayBool returns new ArrayBool with the given name and description.
func (*ArrayBool) GetOptionalArg ¶
GetOptionalArg returns optional arg under the given argIdx.
func (*ArrayBool) IsBoolFlag ¶
IsBoolFlag implements flag.IsBoolFlag interface
type ArrayBytes ¶
type ArrayBytes struct {
// contains filtered or unexported fields
}
ArrayBytes is flag that holds an array of Bytes.
Has the same api as ArrayString.
func NewArrayBytes ¶
func NewArrayBytes(name string, defaultValue int64, description string) *ArrayBytes
NewArrayBytes returns new ArrayBytes with the given name, defaultValue and description.
func (*ArrayBytes) GetOptionalArg ¶
func (a *ArrayBytes) GetOptionalArg(argIdx int) int64
GetOptionalArg returns optional arg under the given argIdx, or default value
func (*ArrayBytes) Set ¶
func (a *ArrayBytes) Set(value string) error
Set implemented flag.Value interface
func (*ArrayBytes) String ¶
func (a *ArrayBytes) String() string
String implements flag.Value interface
type ArrayDuration ¶
type ArrayDuration struct {
// contains filtered or unexported fields
}
ArrayDuration is a flag that holds an array of time.Duration values.
Has the same api as ArrayString.
func NewArrayDuration ¶
func NewArrayDuration(name string, defaultValue time.Duration, description string) *ArrayDuration
NewArrayDuration returns new ArrayDuration with the given name, defaultValue and description.
func (*ArrayDuration) GetOptionalArg ¶
func (a *ArrayDuration) GetOptionalArg(argIdx int) time.Duration
GetOptionalArg returns optional arg under the given argIdx, or default value, if argIdx not found.
func (*ArrayDuration) Set ¶
func (a *ArrayDuration) Set(value string) error
Set implements flag.Value interface
func (*ArrayDuration) String ¶
func (a *ArrayDuration) String() string
String implements flag.Value interface
type ArrayInt ¶
type ArrayInt struct {
// contains filtered or unexported fields
}
ArrayInt is flag that holds an array of ints.
Has the same api as ArrayString.
func NewArrayInt ¶
NewArrayInt returns new ArrayInt with the given name, defaultValue and description.
func (*ArrayInt) GetOptionalArg ¶
GetOptionalArg returns optional arg under the given argIdx or default value.
type ArrayString ¶
type ArrayString []string
ArrayString is a flag that holds an array of strings.
It may be set either by specifying multiple flags with the given name passed to NewArray or by joining flag values by comma.
The following example sets equivalent flag array with two items (value1, value2):
-foo=value1 -foo=value2 -foo=value1,value2
Each flag value may contain commas inside single quotes, double quotes, [], () or {} braces. For example, -foo=[a,b,c] defines a single command-line flag with `[a,b,c]` value.
Flag values may be quoted. For instance, the following arg creates an array of ("a", "b,c") items:
-foo='a,"b,c"'
func NewArrayString ¶
func NewArrayString(name, description string) *ArrayString
NewArrayString returns new ArrayString with the given name and description.
func (*ArrayString) GetOptionalArg ¶
func (a *ArrayString) GetOptionalArg(argIdx int) string
GetOptionalArg returns optional arg under the given argIdx.
func (*ArrayString) Set ¶
func (a *ArrayString) Set(value string) error
Set implements flag.Value interface
func (*ArrayString) String ¶
func (a *ArrayString) String() string
String implements flag.Value interface
type Bytes ¶
type Bytes struct {
// N contains parsed value for the given flag.
N int64
// contains filtered or unexported fields
}
Bytes is a flag for holding size in bytes.
It supports the following optional suffixes for values: KB, MB, GB, TB, KiB, MiB, GiB, TiB.
type DictInt ¶
type DictInt struct {
// contains filtered or unexported fields
}
DictInt allows specifying a dictionary of named ints in the form `name1:value1,...,nameN:valueN`.
func NewDictInt ¶
NewDictInt creates DictInt with the given name, defaultValue and description.
func (*DictInt) Get ¶
Get returns value for the given key.
Default value is returned if key isn't found in di.
type Password ¶
type Password struct {
// contains filtered or unexported fields
}
Password is a flag holding a password.
If the flag value is file:///path/to/file or http://host/path , then its contents is automatically re-read from the given file or url
func NewPassword ¶
NewPassword returns new `password` flag with the given name and description.
The password value is hidden when calling Password.String() for security reasons, since the returned value can be put in logs. Call Password.Get() for obtaining the real password value.
func (*Password) Get ¶
Get returns the current p value.
It re-reads p value from the file:///path/to/file or http://host/path if they were passed to Password.Set.
type RetentionDuration ¶
type RetentionDuration struct {
// contains filtered or unexported fields
}
RetentionDuration is a flag for holding duration for retention period.
func NewRetentionDuration ¶
func NewRetentionDuration(name string, defaultValue string, description string) *RetentionDuration
NewRetentionDuration returns new `duration` flag with the given name, defaultValue and description.
DefaultValue is in months.
func (*RetentionDuration) Duration ¶
func (d *RetentionDuration) Duration() time.Duration
Duration returns d as time.Duration
func (*RetentionDuration) Milliseconds ¶
func (d *RetentionDuration) Milliseconds() int64
Milliseconds returns d in milliseconds
func (*RetentionDuration) Set ¶
func (d *RetentionDuration) Set(value string) error
Set implements flag.Value interface It assumes that value without unit should be parsed as `month` duration. It returns an error if value has `m` unit.
func (*RetentionDuration) String ¶
func (d *RetentionDuration) String() string
String implements flag.Value interface
Source Files