flag

Documentation

Index

• func AddFlags(fs *pflag.FlagSet)
• func ConfigVar(p *ConfigValue, name string, value ConfigValue, usage string)
• func PrintDefaultConfigAndExitIfRequested(config interface{})
• func PrintFlags(flags *pflag.FlagSet)
• func PrintMinConfigAndExitIfRequested(config interface{})
• type ConfigValue
  • func Config(name string, value ConfigValue, usage string) *ConfigValue
  • func (m *ConfigValue) Get() interface{}
  • func (m *ConfigValue) IsBoolFlag() bool
  • func (m *ConfigValue) Set(s string) error
  • func (m *ConfigValue) String() string
  • func (m *ConfigValue) Type() string

Functions

func AddFlags

func AddFlags(fs *pflag.FlagSet)

AddFlags registers this package's flags on arbitrary FlagSets, such that they point to the same value as the global flags.

func ConfigVar

func ConfigVar(p *ConfigValue, name string, value ConfigValue, usage string)

func PrintDefaultConfigAndExitIfRequested

func PrintDefaultConfigAndExitIfRequested(config interface{})

PrintDefaultConfigAndExitIfRequested will check if the -defaultconfig flag was passed and, if so, print the default config and exit.

func PrintFlags

func PrintFlags(flags *pflag.FlagSet)

PrintFlags logs the flags in the flagset

func PrintMinConfigAndExitIfRequested

func PrintMinConfigAndExitIfRequested(config interface{})

PrintMinConfigAndExitIfRequested will check if the -minconfig flag was passed and, if so, print the min config and exit.

Types

type ConfigValue

type ConfigValue int

const (
	ConfigFalse ConfigValue = 0
	ConfigTrue  ConfigValue = 1
)

func Config

func Config(name string, value ConfigValue, usage string) *ConfigValue

func (*ConfigValue) Get

func (m *ConfigValue) Get() interface{}

func (*ConfigValue) IsBoolFlag

func (m *ConfigValue) IsBoolFlag() bool

func (*ConfigValue) Set

func (m *ConfigValue) Set(s string) error

func (*ConfigValue) String

func (m *ConfigValue) String() string

func (*ConfigValue) Type

func (m *ConfigValue) Type() string

The type of the flag as required by the pflag.Value interface