flags

Documentation

Index

• Variables
• func BoolToBoolValueFunc() mapstructure.DecodeHookFunc
• func Float64ToUintValueFunc() mapstructure.DecodeHookFunc
• func Merge(dst, src *flag.FlagSet)
• func StringToDurationValueFunc() mapstructure.DecodeHookFunc
• func StringToStringValueFunc() mapstructure.DecodeHookFunc
• func Usage(txt string, flags *flag.FlagSet) string
• func Visit(path string, visitor VisitFn) error
• type AppendSliceValue
  • func (s *AppendSliceValue) Set(value string) error
  • func (s *AppendSliceValue) String() string
• type BoolValue
  • func (b *BoolValue) IsBoolFlag() bool
  • func (b *BoolValue) Merge(onto *bool)
  • func (b *BoolValue) Set(v string) error
  • func (b *BoolValue) String() string
• type DurationValue
  • func (d *DurationValue) Merge(onto *time.Duration)
  • func (d *DurationValue) Set(v string) error
  • func (d *DurationValue) String() string
• type FlagMapValue
  • func (h *FlagMapValue) Set(value string) error
  • func (h *FlagMapValue) String() string
• type HTTPFlags
  • func (f *HTTPFlags) APIClient() (*api.Client, error)
  • func (f *HTTPFlags) AddPartitionFlag(fs *flag.FlagSet)
  • func (f *HTTPFlags) Addr() string
  • func (f *HTTPFlags) ClientFlags() *flag.FlagSet
  • func (f *HTTPFlags) Datacenter() string
  • func (f *HTTPFlags) MergeOntoConfig(c *api.Config)
  • func (f *HTTPFlags) MultiTenancyFlags() *flag.FlagSet
  • func (f *HTTPFlags) PartitionFlag() *flag.FlagSet
  • func (f *HTTPFlags) ReadTokenFile() (string, error)
  • func (f *HTTPFlags) ServerFlags() *flag.FlagSet
  • func (f *HTTPFlags) SetToken(v string) error
  • func (f *HTTPFlags) SetTokenFile(v string) error
  • func (f *HTTPFlags) Stale() bool
  • func (f *HTTPFlags) Token() string
  • func (f *HTTPFlags) TokenFile() string
• type StringValue
  • func (s *StringValue) Merge(onto *string)
  • func (s *StringValue) Set(v string) error
  • func (s *StringValue) String() string
• type UintValue
  • func (u *UintValue) Merge(onto *uint)
  • func (u *UintValue) Set(v string) error
  • func (u *UintValue) String() string
• type Usager
  • func (u *Usager) String() string
• type VisitFn

Variables

var ConfigDecodeHook = mapstructure.ComposeDecodeHookFunc(
	BoolToBoolValueFunc(),
	StringToDurationValueFunc(),
	StringToStringValueFunc(),
	Float64ToUintValueFunc(),
)

ConfigDecodeHook should be passed to mapstructure in order to decode into the *Value objects here.

Functions

func BoolToBoolValueFunc

func BoolToBoolValueFunc() mapstructure.DecodeHookFunc

BoolToBoolValueFunc is a mapstructure hook that looks for an incoming bool mapped to a BoolValue and does the translation.

func Float64ToUintValueFunc

func Float64ToUintValueFunc() mapstructure.DecodeHookFunc

Float64ToUintValueFunc is a mapstructure hook that looks for an incoming float64 mapped to a UintValue and does the translation.

func Merge

func Merge(dst, src *flag.FlagSet)

func StringToDurationValueFunc

func StringToDurationValueFunc() mapstructure.DecodeHookFunc

StringToDurationValueFunc is a mapstructure hook that looks for an incoming string mapped to a DurationValue and does the translation.

func StringToStringValueFunc

func StringToStringValueFunc() mapstructure.DecodeHookFunc

StringToStringValueFunc is a mapstructure hook that looks for an incoming string mapped to a StringValue and does the translation.

func Usage

func Usage(txt string, flags *flag.FlagSet) string

func Visit

func Visit(path string, visitor VisitFn) error

Visit will call the visitor function on the path if it's a file, or for each file in the path if it's a directory. Directories will not be recursed into, and files in the directory will be visited in alphabetical order.

Types

type AppendSliceValue

type AppendSliceValue []string

AppendSliceValue implements the flag.Value interface and allows multiple calls to the same variable to append a list.

func (*AppendSliceValue) Set

func (s *AppendSliceValue) Set(value string) error

func (*AppendSliceValue) String

func (s *AppendSliceValue) String() string

type BoolValue

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

BoolValue provides a flag value that's aware if it has been set.

func (*BoolValue) IsBoolFlag

func (b *BoolValue) IsBoolFlag() bool

IsBoolFlag is an optional method of the flag.Value interface which marks this value as boolean when the return value is true. See flag.Value for details.

func (*BoolValue) Merge

func (b *BoolValue) Merge(onto *bool)

Merge will overlay this value if it has been set.

func (*BoolValue) Set

func (b *BoolValue) Set(v string) error

Set implements the flag.Value interface.

func (*BoolValue) String

func (b *BoolValue) String() string

String implements the flag.Value interface.

type DurationValue

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

DurationValue provides a flag value that's aware if it has been set.

func (*DurationValue) Merge

func (d *DurationValue) Merge(onto *time.Duration)

Merge will overlay this value if it has been set.

func (*DurationValue) Set

func (d *DurationValue) Set(v string) error

Set implements the flag.Value interface.

func (*DurationValue) String

func (d *DurationValue) String() string

String implements the flag.Value interface.

type FlagMapValue

type FlagMapValue map[string]string

FlagMapValue is a flag implementation used to provide key=value semantics multiple times.

func (*FlagMapValue) Set

func (h *FlagMapValue) Set(value string) error

func (*FlagMapValue) String

func (h *FlagMapValue) String() string

type HTTPFlags

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

func (*HTTPFlags) APIClient

func (f *HTTPFlags) APIClient() (*api.Client, error)

func (*HTTPFlags) AddPartitionFlag

func (f *HTTPFlags) AddPartitionFlag(fs *flag.FlagSet)

func (*HTTPFlags) Addr

func (f *HTTPFlags) Addr() string

func (*HTTPFlags) ClientFlags

func (f *HTTPFlags) ClientFlags() *flag.FlagSet

func (*HTTPFlags) Datacenter

func (f *HTTPFlags) Datacenter() string

func (*HTTPFlags) MergeOntoConfig

func (f *HTTPFlags) MergeOntoConfig(c *api.Config)

func (*HTTPFlags) MultiTenancyFlags

func (f *HTTPFlags) MultiTenancyFlags() *flag.FlagSet

func (*HTTPFlags) PartitionFlag

func (f *HTTPFlags) PartitionFlag() *flag.FlagSet

func (*HTTPFlags) ReadTokenFile

func (f *HTTPFlags) ReadTokenFile() (string, error)

func (*HTTPFlags) ServerFlags

func (f *HTTPFlags) ServerFlags() *flag.FlagSet

func (*HTTPFlags) SetToken

func (f *HTTPFlags) SetToken(v string) error

func (*HTTPFlags) SetTokenFile

func (f *HTTPFlags) SetTokenFile(v string) error

func (*HTTPFlags) Stale

func (f *HTTPFlags) Stale() bool

func (*HTTPFlags) Token

func (f *HTTPFlags) Token() string

func (*HTTPFlags) TokenFile

func (f *HTTPFlags) TokenFile() string

type StringValue

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

StringValue provides a flag value that's aware if it has been set.

func (*StringValue) Merge

func (s *StringValue) Merge(onto *string)

Merge will overlay this value if it has been set.

func (*StringValue) Set

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

Set implements the flag.Value interface.

func (*StringValue) String

func (s *StringValue) String() string

String implements the flag.Value interface.

type UintValue

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

UintValue provides a flag value that's aware if it has been set.

func (*UintValue) Merge

func (u *UintValue) Merge(onto *uint)

Merge will overlay this value if it has been set.

func (*UintValue) Set

func (u *UintValue) Set(v string) error

Set implements the flag.Value interface.

func (*UintValue) String

func (u *UintValue) String() string

String implements the flag.Value interface.

type Usager

type Usager struct {
	Usage string
	Flags *flag.FlagSet
}

func (*Usager) String

func (u *Usager) String() string

type VisitFn

type VisitFn func(path string) error

VisitFn is a callback that gets a chance to visit each file found during a traversal with visit().