Documentation
¶
Overview ¶
Package pflag is a drop-in replacement for Go's flag package, implementing POSIX/GNU-style --flags.
pflag is compatible with the GNU extensions to the POSIX recommendations for command-line options. See http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html
Usage:
pflag is a drop-in replacement of Go's native flag package. If you import pflag under the name "flag" then all code should continue to function with no changes.
import flag "github.com/erfanmomeniii/pflag"
There is one exception to this: if you directly instantiate the Flag struct there is one more field "Shorthand" that you will need to set. Most code never instantiates this struct directly, and instead uses functions such as String(), BoolVar(), and Var(), and is therefore unaffected.
Define flags using flag.String(), Bool(), Int(), etc.
This declares an integer flag, -flagname, stored in the pointer ip, with type *int.
var ip = flag.Int("flagname", 1234, "help message for flagname")
If you like, you can bind the flag to a variable using the Var() functions.
var flagvar int func init() { flag.IntVar(&flagvar, "flagname", 1234, "help message for flagname") }
Or you can create custom flags that satisfy the Value interface (with pointer receivers) and couple them to flag parsing by
flag.Var(&flagVal, "name", "help message for flagname")
For such flags, the default value is just the initial value of the variable.
After all flags are defined, call
flag.Parse()
to parse the command line into the defined flags.
Flags may then be used directly. If you're using the flags themselves, they are all pointers; if you bind to variables, they're values.
fmt.Println("ip has value ", *ip) fmt.Println("flagvar has value ", flagvar)
After parsing, the arguments after the flag are available as the slice flag.Args() or individually as flag.Arg(i). The arguments are indexed from 0 through flag.NArg()-1.
The pflag package also defines some new functions that are not in flag, that give one-letter shorthands for flags. You can use these by appending 'P' to the name of any function that defines a flag.
var ip = flag.IntP("flagname", "f", 1234, "help message") var flagvar bool func init() { flag.BoolVarP(&flagvar, "boolname", "b", true, "help message") } flag.VarP(&flagval, "varname", "v", "help message")
Shorthand letters can be used with single dashes on the command line. Boolean shorthand flags can be combined with other shorthand flags.
Command line flag syntax:
--flag // boolean flags only --flag=x
Unlike the flag package, a single dash before an option means something different than a double dash. Single dashes signify a series of shorthand letters for flags. All but the last shorthand letter must be boolean flags.
// boolean flags -f -abc // non-boolean flags -n 1234 -Ifile // mixed -abcs "hello" -abcn1234
Flag parsing stops after the terminator "--". Unlike the flag package, flags can be interspersed with arguments anywhere on the command line before this terminator.
Integer flags accept 1234, 0664, 0x1234 and may be negative. Boolean flags (in their long form) accept 1, 0, t, f, true, false, TRUE, FALSE, True, False. Duration flags accept any input valid for time.ParseDuration.
The default set of command-line flags is controlled by top-level functions. The FlagSet type allows one to define independent sets of flags, such as to implement subcommands in a command-line interface. The methods of FlagSet are analogous to the top-level functions for the command-line flag set.
Index ¶
- Variables
- func Arg(i int) string
- func Args() []string
- func Bool(name string, value bool, usage string, validation ...func(value bool) error) *bool
- func BoolP(name, shorthand string, value bool, usage string, ...) *bool
- func BoolSlice(name string, value []bool, usage string, ...) *[]bool
- func BoolSliceP(name, shorthand string, value []bool, usage string, ...) *[]bool
- func BoolSliceVar(p *[]bool, name string, value []bool, usage string, ...)
- func BoolSliceVarP(p *[]bool, name, shorthand string, value []bool, usage string, ...)
- func BoolVar(p *bool, name string, value bool, usage string, ...)
- func BoolVarP(p *bool, name, shorthand string, value bool, usage string, ...)
- func BytesBase64(name string, value []byte, usage string, ...) *[]byte
- func BytesBase64P(name, shorthand string, value []byte, usage string, ...) *[]byte
- func BytesBase64Var(p *[]byte, name string, value []byte, usage string, ...)
- func BytesBase64VarP(p *[]byte, name, shorthand string, value []byte, usage string, ...)
- func BytesHex(name string, value []byte, usage string, ...) *[]byte
- func BytesHexP(name, shorthand string, value []byte, usage string, ...) *[]byte
- func BytesHexVar(p *[]byte, name string, value []byte, usage string, ...)
- func BytesHexVarP(p *[]byte, name, shorthand string, value []byte, usage string, ...)
- func Count(name string, usage string, validation ...func(value int) error) *int
- func CountP(name, shorthand string, usage string, validation ...func(value int) error) *int
- func CountVar(p *int, name string, usage string, validation ...func(value int) error)
- func CountVarP(p *int, name, shorthand string, usage string, ...)
- func Duration(name string, value time.Duration, usage string, ...) *time.Duration
- func DurationP(name, shorthand string, value time.Duration, usage string, ...) *time.Duration
- func DurationSlice(name string, value []time.Duration, usage string, ...) *[]time.Duration
- func DurationSliceP(name, shorthand string, value []time.Duration, usage string, ...) *[]time.Duration
- func DurationSliceVar(p *[]time.Duration, name string, value []time.Duration, usage string, ...)
- func DurationSliceVarP(p *[]time.Duration, name, shorthand string, value []time.Duration, ...)
- func DurationVar(p *time.Duration, name string, value time.Duration, usage string, ...)
- func DurationVarP(p *time.Duration, name, shorthand string, value time.Duration, usage string, ...)
- func Float32(name string, value float32, usage string, ...) *float32
- func Float32P(name, shorthand string, value float32, usage string, ...) *float32
- func Float32Slice(name string, value []float32, usage string, ...) *[]float32
- func Float32SliceP(name, shorthand string, value []float32, usage string, ...) *[]float32
- func Float32SliceVar(p *[]float32, name string, value []float32, usage string, ...)
- func Float32SliceVarP(p *[]float32, name, shorthand string, value []float32, usage string, ...)
- func Float32Var(p *float32, name string, value float32, usage string, ...)
- func Float32VarP(p *float32, name, shorthand string, value float32, usage string, ...)
- func Float64(name string, value float64, usage string, ...) *float64
- func Float64P(name, shorthand string, value float64, usage string, ...) *float64
- func Float64Slice(name string, value []float64, usage string, ...) *[]float64
- func Float64SliceP(name, shorthand string, value []float64, usage string, ...) *[]float64
- func Float64SliceVar(p *[]float64, name string, value []float64, usage string, ...)
- func Float64SliceVarP(p *[]float64, name, shorthand string, value []float64, usage string, ...)
- func Float64Var(p *float64, name string, value float64, usage string, ...)
- func Float64VarP(p *float64, name, shorthand string, value float64, usage string, ...)
- func IP(name string, value net.IP, usage string, ...) *net.IP
- func IPMask(name string, value net.IPMask, usage string, ...) *net.IPMask
- func IPMaskP(name, shorthand string, value net.IPMask, usage string, ...) *net.IPMask
- func IPMaskVar(p *net.IPMask, name string, value net.IPMask, usage string, ...)
- func IPMaskVarP(p *net.IPMask, name, shorthand string, value net.IPMask, usage string, ...)
- func IPNet(name string, value net.IPNet, usage string, ...) *net.IPNet
- func IPNetP(name, shorthand string, value net.IPNet, usage string, ...) *net.IPNet
- func IPNetSlice(name string, value []net.IPNet, usage string, ...) *[]net.IPNet
- func IPNetSliceP(name, shorthand string, value []net.IPNet, usage string, ...) *[]net.IPNet
- func IPNetSliceVar(p *[]net.IPNet, name string, value []net.IPNet, usage string, ...)
- func IPNetSliceVarP(p *[]net.IPNet, name, shorthand string, value []net.IPNet, usage string, ...)
- func IPNetVar(p *net.IPNet, name string, value net.IPNet, usage string, ...)
- func IPNetVarP(p *net.IPNet, name, shorthand string, value net.IPNet, usage string, ...)
- func IPP(name, shorthand string, value net.IP, usage string, ...) *net.IP
- func IPSlice(name string, value []net.IP, usage string, ...) *[]net.IP
- func IPSliceP(name, shorthand string, value []net.IP, usage string, ...) *[]net.IP
- func IPSliceVar(p *[]net.IP, name string, value []net.IP, usage string, ...)
- func IPSliceVarP(p *[]net.IP, name, shorthand string, value []net.IP, usage string, ...)
- func IPVar(p *net.IP, name string, value net.IP, usage string, ...)
- func IPVarP(p *net.IP, name, shorthand string, value net.IP, usage string, ...)
- func Int(name string, value int, usage string, validation ...func(value int) error) *int
- func Int16(name string, value int16, usage string, validation ...func(value int16) error) *int16
- func Int16P(name, shorthand string, value int16, usage string, ...) *int16
- func Int16Var(p *int16, name string, value int16, usage string, ...)
- func Int16VarP(p *int16, name, shorthand string, value int16, usage string, ...)
- func Int32(name string, value int32, usage string, validation ...func(value int32) error) *int32
- func Int32P(name, shorthand string, value int32, usage string, ...) *int32
- func Int32Slice(name string, value []int32, usage string, ...) *[]int32
- func Int32SliceP(name, shorthand string, value []int32, usage string, ...) *[]int32
- func Int32SliceVar(p *[]int32, name string, value []int32, usage string, ...)
- func Int32SliceVarP(p *[]int32, name, shorthand string, value []int32, usage string, ...)
- func Int32Var(p *int32, name string, value int32, usage string, ...)
- func Int32VarP(p *int32, name, shorthand string, value int32, usage string, ...)
- func Int64(name string, value int64, usage string, validation ...func(value int64) error) *int64
- func Int64P(name, shorthand string, value int64, usage string, ...) *int64
- func Int64Slice(name string, value []int64, usage string, ...) *[]int64
- func Int64SliceP(name, shorthand string, value []int64, usage string, ...) *[]int64
- func Int64SliceVar(p *[]int64, name string, value []int64, usage string, ...)
- func Int64SliceVarP(p *[]int64, name, shorthand string, value []int64, usage string, ...)
- func Int64Var(p *int64, name string, value int64, usage string, ...)
- func Int64VarP(p *int64, name, shorthand string, value int64, usage string, ...)
- func Int8(name string, value int8, usage string, validation ...func(value int8) error) *int8
- func Int8P(name, shorthand string, value int8, usage string, ...) *int8
- func Int8Var(p *int8, name string, value int8, usage string, ...)
- func Int8VarP(p *int8, name, shorthand string, value int8, usage string, ...)
- func IntP(name, shorthand string, value int, usage string, ...) *int
- func IntSlice(name string, value []int, usage string, validation ...func(value []int) error) *[]int
- func IntSliceP(name, shorthand string, value []int, usage string, ...) *[]int
- func IntSliceVar(p *[]int, name string, value []int, usage string, ...)
- func IntSliceVarP(p *[]int, name, shorthand string, value []int, usage string, ...)
- func IntVar(p *int, name string, value int, usage string, ...)
- func IntVarP(p *int, name, shorthand string, value int, usage string, ...)
- func NArg() int
- func NFlag() int
- func Parse()
- func ParseAll(fn func(flag *Flag, value string) error)
- func ParseIPv4Mask(s string) net.IPMask
- func Parsed() bool
- func PrintDefaults()
- func Set(name, value string) error
- func SetInterspersed(interspersed bool)
- func String(name string, value string, usage string, ...) *string
- func StringArray(name string, value []string, usage string, ...) *[]string
- func StringArrayP(name, shorthand string, value []string, usage string, ...) *[]string
- func StringArrayVar(p *[]string, name string, value []string, usage string, ...)
- func StringArrayVarP(p *[]string, name, shorthand string, value []string, usage string, ...)
- func StringP(name, shorthand string, value string, usage string, ...) *string
- func StringSlice(name string, value []string, usage string, ...) *[]string
- func StringSliceP(name, shorthand string, value []string, usage string, ...) *[]string
- func StringSliceVar(p *[]string, name string, value []string, usage string, ...)
- func StringSliceVarP(p *[]string, name, shorthand string, value []string, usage string, ...)
- func StringToInt(name string, value map[string]int, usage string, ...) *map[string]int
- func StringToInt64(name string, value map[string]int64, usage string, ...) *map[string]int64
- func StringToInt64P(name, shorthand string, value map[string]int64, usage string, ...) *map[string]int64
- func StringToInt64Var(p *map[string]int64, name string, value map[string]int64, usage string, ...)
- func StringToInt64VarP(p *map[string]int64, name, shorthand string, value map[string]int64, ...)
- func StringToIntP(name, shorthand string, value map[string]int, usage string, ...) *map[string]int
- func StringToIntVar(p *map[string]int, name string, value map[string]int, usage string, ...)
- func StringToIntVarP(p *map[string]int, name, shorthand string, value map[string]int, usage string, ...)
- func StringToString(name string, value map[string]string, usage string, ...) *map[string]string
- func StringToStringP(name, shorthand string, value map[string]string, usage string, ...) *map[string]string
- func StringToStringVar(p *map[string]string, name string, value map[string]string, usage string, ...)
- func StringToStringVarP(p *map[string]string, name, shorthand string, value map[string]string, ...)
- func StringVar(p *string, name string, value string, usage string, ...)
- func StringVarP(p *string, name, shorthand string, value string, usage string, ...)
- func Uint(name string, value uint, usage string, validation ...func(value uint) error) *uint
- func Uint16(name string, value uint16, usage string, ...) *uint16
- func Uint16P(name, shorthand string, value uint16, usage string, ...) *uint16
- func Uint16Var(p *uint16, name string, value uint16, usage string, ...)
- func Uint16VarP(p *uint16, name, shorthand string, value uint16, usage string, ...)
- func Uint32(name string, value uint32, usage string, ...) *uint32
- func Uint32P(name, shorthand string, value uint32, usage string, ...) *uint32
- func Uint32Var(p *uint32, name string, value uint32, usage string, ...)
- func Uint32VarP(p *uint32, name, shorthand string, value uint32, usage string, ...)
- func Uint64(name string, value uint64, usage string, ...) *uint64
- func Uint64P(name, shorthand string, value uint64, usage string, ...) *uint64
- func Uint64Var(p *uint64, name string, value uint64, usage string, ...)
- func Uint64VarP(p *uint64, name, shorthand string, value uint64, usage string, ...)
- func Uint8(name string, value uint8, usage string, validation ...func(value uint8) error) *uint8
- func Uint8P(name, shorthand string, value uint8, usage string, ...) *uint8
- func Uint8Var(p *uint8, name string, value uint8, usage string, ...)
- func Uint8VarP(p *uint8, name, shorthand string, value uint8, usage string, ...)
- func UintP(name, shorthand string, value uint, usage string, ...) *uint
- func UintSlice(name string, value []uint, usage string, ...) *[]uint
- func UintSliceP(name, shorthand string, value []uint, usage string, ...) *[]uint
- func UintSliceVar(p *[]uint, name string, value []uint, usage string, ...)
- func UintSliceVarP(p *[]uint, name, shorthand string, value []uint, usage string, ...)
- func UintVar(p *uint, name string, value uint, usage string, ...)
- func UintVarP(p *uint, name, shorthand string, value uint, usage string, ...)
- func UnquoteUsage(flag *Flag) (name string, usage string)
- func Var(value Value, name string, usage string, ...)
- func VarP(value Value, name, shorthand, usage string, ...)
- func Visit(fn func(*Flag))
- func VisitAll(fn func(*Flag))
- type ErrorHandling
- type Flag
- type FlagSet
- func (f *FlagSet) AddFlag(flag *Flag)
- func (f *FlagSet) AddFlagSet(newSet *FlagSet)
- func (f *FlagSet) AddGoFlag(goflag *goflag.Flag)
- func (f *FlagSet) AddGoFlagSet(newSet *goflag.FlagSet)
- func (f *FlagSet) Arg(i int) string
- func (f *FlagSet) Args() []string
- func (f *FlagSet) ArgsLenAtDash() int
- func (f *FlagSet) Bool(name string, value bool, usage string, validation ...func(value bool) error) *bool
- func (f *FlagSet) BoolP(name, shorthand string, value bool, usage string, ...) *bool
- func (f *FlagSet) BoolSlice(name string, value []bool, usage string, ...) *[]bool
- func (f *FlagSet) BoolSliceP(name, shorthand string, value []bool, usage string, ...) *[]bool
- func (f *FlagSet) BoolSliceVar(p *[]bool, name string, value []bool, usage string, ...)
- func (f *FlagSet) BoolSliceVarP(p *[]bool, name, shorthand string, value []bool, usage string, ...)
- func (f *FlagSet) BoolVar(p *bool, name string, value bool, usage string, ...)
- func (f *FlagSet) BoolVarP(p *bool, name, shorthand string, value bool, usage string, ...)
- func (f *FlagSet) BytesBase64(name string, value []byte, usage string, ...) *[]byte
- func (f *FlagSet) BytesBase64P(name, shorthand string, value []byte, usage string, ...) *[]byte
- func (f *FlagSet) BytesBase64Var(p *[]byte, name string, value []byte, usage string, ...)
- func (f *FlagSet) BytesBase64VarP(p *[]byte, name, shorthand string, value []byte, usage string, ...)
- func (f *FlagSet) BytesHex(name string, value []byte, usage string, ...) *[]byte
- func (f *FlagSet) BytesHexP(name, shorthand string, value []byte, usage string, ...) *[]byte
- func (f *FlagSet) BytesHexVar(p *[]byte, name string, value []byte, usage string, ...)
- func (f *FlagSet) BytesHexVarP(p *[]byte, name, shorthand string, value []byte, usage string, ...)
- func (f *FlagSet) Changed(name string) bool
- func (f *FlagSet) Count(name string, usage string, validation ...func(value int) error) *int
- func (f *FlagSet) CountP(name, shorthand string, usage string, validation ...func(value int) error) *int
- func (f *FlagSet) CountVar(p *int, name string, usage string, validation ...func(value int) error)
- func (f *FlagSet) CountVarP(p *int, name, shorthand string, usage string, ...)
- func (f *FlagSet) Duration(name string, value time.Duration, usage string, ...) *time.Duration
- func (f *FlagSet) DurationP(name, shorthand string, value time.Duration, usage string, ...) *time.Duration
- func (f *FlagSet) DurationSlice(name string, value []time.Duration, usage string, ...) *[]time.Duration
- func (f *FlagSet) DurationSliceP(name, shorthand string, value []time.Duration, usage string, ...) *[]time.Duration
- func (f *FlagSet) DurationSliceVar(p *[]time.Duration, name string, value []time.Duration, usage string, ...)
- func (f *FlagSet) DurationSliceVarP(p *[]time.Duration, name, shorthand string, value []time.Duration, ...)
- func (f *FlagSet) DurationVar(p *time.Duration, name string, value time.Duration, usage string, ...)
- func (f *FlagSet) DurationVarP(p *time.Duration, name, shorthand string, value time.Duration, usage string, ...)
- func (f *FlagSet) FlagUsages() string
- func (f *FlagSet) FlagUsagesWrapped(cols int) string
- func (f *FlagSet) Float32(name string, value float32, usage string, ...) *float32
- func (f *FlagSet) Float32P(name, shorthand string, value float32, usage string, ...) *float32
- func (f *FlagSet) Float32Slice(name string, value []float32, usage string, ...) *[]float32
- func (f *FlagSet) Float32SliceP(name, shorthand string, value []float32, usage string, ...) *[]float32
- func (f *FlagSet) Float32SliceVar(p *[]float32, name string, value []float32, usage string, ...)
- func (f *FlagSet) Float32SliceVarP(p *[]float32, name, shorthand string, value []float32, usage string, ...)
- func (f *FlagSet) Float32Var(p *float32, name string, value float32, usage string, ...)
- func (f *FlagSet) Float32VarP(p *float32, name, shorthand string, value float32, usage string, ...)
- func (f *FlagSet) Float64(name string, value float64, usage string, ...) *float64
- func (f *FlagSet) Float64P(name, shorthand string, value float64, usage string, ...) *float64
- func (f *FlagSet) Float64Slice(name string, value []float64, usage string, ...) *[]float64
- func (f *FlagSet) Float64SliceP(name, shorthand string, value []float64, usage string, ...) *[]float64
- func (f *FlagSet) Float64SliceVar(p *[]float64, name string, value []float64, usage string, ...)
- func (f *FlagSet) Float64SliceVarP(p *[]float64, name, shorthand string, value []float64, usage string, ...)
- func (f *FlagSet) Float64Var(p *float64, name string, value float64, usage string, ...)
- func (f *FlagSet) Float64VarP(p *float64, name, shorthand string, value float64, usage string, ...)
- func (f *FlagSet) GetBool(name string) (bool, error)
- func (f *FlagSet) GetBoolSlice(name string) ([]bool, error)
- func (f *FlagSet) GetBytesBase64(name string) ([]byte, error)
- func (f *FlagSet) GetBytesHex(name string) ([]byte, error)
- func (f *FlagSet) GetCount(name string) (int, error)
- func (f *FlagSet) GetDuration(name string) (time.Duration, error)
- func (f *FlagSet) GetDurationSlice(name string) ([]time.Duration, error)
- func (f *FlagSet) GetFloat32(name string) (float32, error)
- func (f *FlagSet) GetFloat32Slice(name string) ([]float32, error)
- func (f *FlagSet) GetFloat64(name string) (float64, error)
- func (f *FlagSet) GetFloat64Slice(name string) ([]float64, error)
- func (f *FlagSet) GetIP(name string) (net.IP, error)
- func (f *FlagSet) GetIPNet(name string) (net.IPNet, error)
- func (f *FlagSet) GetIPNetSlice(name string) ([]net.IPNet, error)
- func (f *FlagSet) GetIPSlice(name string) ([]net.IP, error)
- func (f *FlagSet) GetIPv4Mask(name string) (net.IPMask, error)
- func (f *FlagSet) GetInt(name string) (int, error)
- func (f *FlagSet) GetInt16(name string) (int16, error)
- func (f *FlagSet) GetInt32(name string) (int32, error)
- func (f *FlagSet) GetInt32Slice(name string) ([]int32, error)
- func (f *FlagSet) GetInt64(name string) (int64, error)
- func (f *FlagSet) GetInt64Slice(name string) ([]int64, error)
- func (f *FlagSet) GetInt8(name string) (int8, error)
- func (f *FlagSet) GetIntSlice(name string) ([]int, error)
- func (f *FlagSet) GetNormalizeFunc() func(f *FlagSet, name string) NormalizedName
- func (f *FlagSet) GetString(name string) (string, error)
- func (f *FlagSet) GetStringArray(name string) ([]string, error)
- func (f *FlagSet) GetStringSlice(name string) ([]string, error)
- func (f *FlagSet) GetStringToInt(name string) (map[string]int, error)
- func (f *FlagSet) GetStringToInt64(name string) (map[string]int64, error)
- func (f *FlagSet) GetStringToString(name string) (map[string]string, error)
- func (f *FlagSet) GetUint(name string) (uint, error)
- func (f *FlagSet) GetUint16(name string) (uint16, error)
- func (f *FlagSet) GetUint32(name string) (uint32, error)
- func (f *FlagSet) GetUint64(name string) (uint64, error)
- func (f *FlagSet) GetUint8(name string) (uint8, error)
- func (f *FlagSet) GetUintSlice(name string) ([]uint, error)
- func (f *FlagSet) HasAvailableFlags() bool
- func (f *FlagSet) HasFlags() bool
- func (f *FlagSet) IP(name string, value net.IP, usage string, ...) *net.IP
- func (f *FlagSet) IPMask(name string, value net.IPMask, usage string, ...) *net.IPMask
- func (f *FlagSet) IPMaskP(name, shorthand string, value net.IPMask, usage string, ...) *net.IPMask
- func (f *FlagSet) IPMaskVar(p *net.IPMask, name string, value net.IPMask, usage string, ...)
- func (f *FlagSet) IPMaskVarP(p *net.IPMask, name, shorthand string, value net.IPMask, usage string, ...)
- func (f *FlagSet) IPNet(name string, value net.IPNet, usage string, ...) *net.IPNet
- func (f *FlagSet) IPNetP(name, shorthand string, value net.IPNet, usage string, ...) *net.IPNet
- func (f *FlagSet) IPNetSlice(name string, value []net.IPNet, usage string, ...) *[]net.IPNet
- func (f *FlagSet) IPNetSliceP(name, shorthand string, value []net.IPNet, usage string, ...) *[]net.IPNet
- func (f *FlagSet) IPNetSliceVar(p *[]net.IPNet, name string, value []net.IPNet, usage string, ...)
- func (f *FlagSet) IPNetSliceVarP(p *[]net.IPNet, name, shorthand string, value []net.IPNet, usage string, ...)
- func (f *FlagSet) IPNetVar(p *net.IPNet, name string, value net.IPNet, usage string, ...)
- func (f *FlagSet) IPNetVarP(p *net.IPNet, name, shorthand string, value net.IPNet, usage string, ...)
- func (f *FlagSet) IPP(name, shorthand string, value net.IP, usage string, ...) *net.IP
- func (f *FlagSet) IPSlice(name string, value []net.IP, usage string, ...) *[]net.IP
- func (f *FlagSet) IPSliceP(name, shorthand string, value []net.IP, usage string, ...) *[]net.IP
- func (f *FlagSet) IPSliceVar(p *[]net.IP, name string, value []net.IP, usage string, ...)
- func (f *FlagSet) IPSliceVarP(p *[]net.IP, name, shorthand string, value []net.IP, usage string, ...)
- func (f *FlagSet) IPVar(p *net.IP, name string, value net.IP, usage string, ...)
- func (f *FlagSet) IPVarP(p *net.IP, name, shorthand string, value net.IP, usage string, ...)
- func (f *FlagSet) Init(name string, errorHandling ErrorHandling)
- func (f *FlagSet) Int(name string, value int, usage string, validation ...func(value int) error) *int
- func (f *FlagSet) Int16(name string, value int16, usage string, validation ...func(value int16) error) *int16
- func (f *FlagSet) Int16P(name, shorthand string, value int16, usage string, ...) *int16
- func (f *FlagSet) Int16Var(p *int16, name string, value int16, usage string, ...)
- func (f *FlagSet) Int16VarP(p *int16, name, shorthand string, value int16, usage string, ...)
- func (f *FlagSet) Int32(name string, value int32, usage string, validation ...func(value int32) error) *int32
- func (f *FlagSet) Int32P(name, shorthand string, value int32, usage string, ...) *int32
- func (f *FlagSet) Int32Slice(name string, value []int32, usage string, ...) *[]int32
- func (f *FlagSet) Int32SliceP(name, shorthand string, value []int32, usage string, ...) *[]int32
- func (f *FlagSet) Int32SliceVar(p *[]int32, name string, value []int32, usage string, ...)
- func (f *FlagSet) Int32SliceVarP(p *[]int32, name, shorthand string, value []int32, usage string, ...)
- func (f *FlagSet) Int32Var(p *int32, name string, value int32, usage string, ...)
- func (f *FlagSet) Int32VarP(p *int32, name, shorthand string, value int32, usage string, ...)
- func (f *FlagSet) Int64(name string, value int64, usage string, validation ...func(value int64) error) *int64
- func (f *FlagSet) Int64P(name, shorthand string, value int64, usage string, ...) *int64
- func (f *FlagSet) Int64Slice(name string, value []int64, usage string, ...) *[]int64
- func (f *FlagSet) Int64SliceP(name, shorthand string, value []int64, usage string, ...) *[]int64
- func (f *FlagSet) Int64SliceVar(p *[]int64, name string, value []int64, usage string, ...)
- func (f *FlagSet) Int64SliceVarP(p *[]int64, name, shorthand string, value []int64, usage string, ...)
- func (f *FlagSet) Int64Var(p *int64, name string, value int64, usage string, ...)
- func (f *FlagSet) Int64VarP(p *int64, name, shorthand string, value int64, usage string, ...)
- func (f *FlagSet) Int8(name string, value int8, usage string, validation ...func(value int8) error) *int8
- func (f *FlagSet) Int8P(name, shorthand string, value int8, usage string, ...) *int8
- func (f *FlagSet) Int8Var(p *int8, name string, value int8, usage string, ...)
- func (f *FlagSet) Int8VarP(p *int8, name, shorthand string, value int8, usage string, ...)
- func (f *FlagSet) IntP(name, shorthand string, value int, usage string, ...) *int
- func (f *FlagSet) IntSlice(name string, value []int, usage string, validation ...func(value []int) error) *[]int
- func (f *FlagSet) IntSliceP(name, shorthand string, value []int, usage string, ...) *[]int
- func (f *FlagSet) IntSliceVar(p *[]int, name string, value []int, usage string, ...)
- func (f *FlagSet) IntSliceVarP(p *[]int, name, shorthand string, value []int, usage string, ...)
- func (f *FlagSet) IntVar(p *int, name string, value int, usage string, ...)
- func (f *FlagSet) IntVarP(p *int, name, shorthand string, value int, usage string, ...)
- func (f *FlagSet) Lookup(name string) *Flag
- func (f *FlagSet) MarkDeprecated(name string, usageMessage string) error
- func (f *FlagSet) MarkHidden(name string) error
- func (f *FlagSet) MarkShorthandDeprecated(name string, usageMessage string) error
- func (f *FlagSet) NArg() int
- func (f *FlagSet) NFlag() int
- func (f *FlagSet) Name() string
- func (f *FlagSet) Output() io.Writer
- func (f *FlagSet) Parse(arguments []string) error
- func (f *FlagSet) ParseAll(arguments []string, fn func(flag *Flag, value string) error) error
- func (f *FlagSet) Parsed() bool
- func (f *FlagSet) PrintDefaults()
- func (f *FlagSet) Set(name, value string) error
- func (f *FlagSet) SetAnnotation(name, key string, values []string) error
- func (f *FlagSet) SetInterspersed(interspersed bool)
- func (f *FlagSet) SetNormalizeFunc(n func(f *FlagSet, name string) NormalizedName)
- func (f *FlagSet) SetOutput(output io.Writer)
- func (f *FlagSet) ShorthandLookup(name string) *Flag
- func (f *FlagSet) String(name string, value string, usage string, ...) *string
- func (f *FlagSet) StringArray(name string, value []string, usage string, ...) *[]string
- func (f *FlagSet) StringArrayP(name, shorthand string, value []string, usage string, ...) *[]string
- func (f *FlagSet) StringArrayVar(p *[]string, name string, value []string, usage string, ...)
- func (f *FlagSet) StringArrayVarP(p *[]string, name, shorthand string, value []string, usage string, ...)
- func (f *FlagSet) StringP(name, shorthand string, value string, usage string, ...) *string
- func (f *FlagSet) StringSlice(name string, value []string, usage string, ...) *[]string
- func (f *FlagSet) StringSliceP(name, shorthand string, value []string, usage string, ...) *[]string
- func (f *FlagSet) StringSliceVar(p *[]string, name string, value []string, usage string, ...)
- func (f *FlagSet) StringSliceVarP(p *[]string, name, shorthand string, value []string, usage string, ...)
- func (f *FlagSet) StringToInt(name string, value map[string]int, usage string, ...) *map[string]int
- func (f *FlagSet) StringToInt64(name string, value map[string]int64, usage string, ...) *map[string]int64
- func (f *FlagSet) StringToInt64P(name, shorthand string, value map[string]int64, usage string, ...) *map[string]int64
- func (f *FlagSet) StringToInt64Var(p *map[string]int64, name string, value map[string]int64, usage string, ...)
- func (f *FlagSet) StringToInt64VarP(p *map[string]int64, name, shorthand string, value map[string]int64, ...)
- func (f *FlagSet) StringToIntP(name, shorthand string, value map[string]int, usage string, ...) *map[string]int
- func (f *FlagSet) StringToIntVar(p *map[string]int, name string, value map[string]int, usage string, ...)
- func (f *FlagSet) StringToIntVarP(p *map[string]int, name, shorthand string, value map[string]int, usage string, ...)
- func (f *FlagSet) StringToString(name string, value map[string]string, usage string, ...) *map[string]string
- func (f *FlagSet) StringToStringP(name, shorthand string, value map[string]string, usage string, ...) *map[string]string
- func (f *FlagSet) StringToStringVar(p *map[string]string, name string, value map[string]string, usage string, ...)
- func (f *FlagSet) StringToStringVarP(p *map[string]string, name, shorthand string, value map[string]string, ...)
- func (f *FlagSet) StringVar(p *string, name string, value string, usage string, ...)
- func (f *FlagSet) StringVarP(p *string, name, shorthand string, value string, usage string, ...)
- func (f *FlagSet) Uint(name string, value uint, usage string, validation ...func(value uint) error) *uint
- func (f *FlagSet) Uint16(name string, value uint16, usage string, ...) *uint16
- func (f *FlagSet) Uint16P(name, shorthand string, value uint16, usage string, ...) *uint16
- func (f *FlagSet) Uint16Var(p *uint16, name string, value uint16, usage string, ...)
- func (f *FlagSet) Uint16VarP(p *uint16, name, shorthand string, value uint16, usage string, ...)
- func (f *FlagSet) Uint32(name string, value uint32, usage string, ...) *uint32
- func (f *FlagSet) Uint32P(name, shorthand string, value uint32, usage string, ...) *uint32
- func (f *FlagSet) Uint32Var(p *uint32, name string, value uint32, usage string, ...)
- func (f *FlagSet) Uint32VarP(p *uint32, name, shorthand string, value uint32, usage string, ...)
- func (f *FlagSet) Uint64(name string, value uint64, usage string, ...) *uint64
- func (f *FlagSet) Uint64P(name, shorthand string, value uint64, usage string, ...) *uint64
- func (f *FlagSet) Uint64Var(p *uint64, name string, value uint64, usage string, ...)
- func (f *FlagSet) Uint64VarP(p *uint64, name, shorthand string, value uint64, usage string, ...)
- func (f *FlagSet) Uint8(name string, value uint8, usage string, validation ...func(value uint8) error) *uint8
- func (f *FlagSet) Uint8P(name, shorthand string, value uint8, usage string, ...) *uint8
- func (f *FlagSet) Uint8Var(p *uint8, name string, value uint8, usage string, ...)
- func (f *FlagSet) Uint8VarP(p *uint8, name, shorthand string, value uint8, usage string, ...)
- func (f *FlagSet) UintP(name, shorthand string, value uint, usage string, ...) *uint
- func (f *FlagSet) UintSlice(name string, value []uint, usage string, ...) *[]uint
- func (f *FlagSet) UintSliceP(name, shorthand string, value []uint, usage string, ...) *[]uint
- func (f *FlagSet) UintSliceVar(p *[]uint, name string, value []uint, usage string, ...)
- func (f *FlagSet) UintSliceVarP(p *[]uint, name, shorthand string, value []uint, usage string, ...)
- func (f *FlagSet) UintVar(p *uint, name string, value uint, usage string, ...)
- func (f *FlagSet) UintVarP(p *uint, name, shorthand string, value uint, usage string, ...)
- func (f *FlagSet) Var(value Value, name string, usage string, validation ...interface{})
- func (f *FlagSet) VarP(value Value, name, shorthand, usage string, validation ...interface{})
- func (f *FlagSet) VarPF(value Value, name, shorthand, usage string, validation ...interface{}) *Flag
- func (f *FlagSet) Visit(fn func(*Flag))
- func (f *FlagSet) VisitAll(fn func(*Flag))
- type NormalizedName
- type ParseErrorsWhitelist
- type SliceValue
- type Value
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var CommandLine = NewFlagSet(os.Args[0], ExitOnError)
CommandLine is the default set of command-line flags, parsed from os.Args.
var ErrHelp = errors.New("pflag: help requested")
ErrHelp is the error returned if the flag -help is invoked but no such flag is defined.
var Usage = func() { fmt.Fprintf(os.Stderr, "Usage of %s:\n", os.Args[0]) PrintDefaults() }
Usage prints to standard error a usage message documenting all defined command-line flags. The function is a variable that may be changed to point to a custom function. By default it prints a simple header and calls PrintDefaults; for details about the format of the output and how to control it, see the documentation for PrintDefaults.
Functions ¶
func Arg ¶
Arg returns the i'th command-line argument. Arg(0) is the first remaining argument after flags have been processed.
func Bool ¶
Bool defines a bool flag with specified name, default value, and usage string. The return value is the address of a bool variable that stores the value of the flag.
func BoolP ¶
func BoolP(name, shorthand string, value bool, usage string, validation ...func(value bool) error) *bool
BoolP is like Bool, but accepts a shorthand letter that can be used after a single dash.
func BoolSlice ¶
func BoolSlice(name string, value []bool, usage string, validation ...func(value []bool) error) *[]bool
BoolSlice defines a []bool flag with specified name, default value, and usage string. The return value is the address of a []bool variable that stores the value of the flag.
func BoolSliceP ¶
func BoolSliceP(name, shorthand string, value []bool, usage string, validation ...func(value []bool) error) *[]bool
BoolSliceP is like BoolSlice, but accepts a shorthand letter that can be used after a single dash.
func BoolSliceVar ¶
func BoolSliceVar(p *[]bool, name string, value []bool, usage string, validation ...func(value []bool) error)
BoolSliceVar defines a []bool flag with specified name, default value, and usage string. The argument p points to a []bool variable in which to store the value of the flag.
func BoolSliceVarP ¶
func BoolSliceVarP(p *[]bool, name, shorthand string, value []bool, usage string, validation ...func(value []bool) error)
BoolSliceVarP is like BoolSliceVar, but accepts a shorthand letter that can be used after a single dash.
func BoolVar ¶
BoolVar defines a bool flag with specified name, default value, and usage string. The argument p points to a bool variable in which to store the value of the flag.
func BoolVarP ¶
func BoolVarP(p *bool, name, shorthand string, value bool, usage string, validation ...func(value bool) error)
BoolVarP is like BoolVar, but accepts a shorthand letter that can be used after a single dash.
func BytesBase64 ¶
func BytesBase64(name string, value []byte, usage string, validation ...func(value []byte) error) *[]byte
BytesBase64 defines an []byte flag with specified name, default value, and usage string. The return value is the address of an []byte variable that stores the value of the flag.
func BytesBase64P ¶
func BytesBase64P(name, shorthand string, value []byte, usage string, validation ...func(value []byte) error) *[]byte
BytesBase64P is like BytesBase64, but accepts a shorthand letter that can be used after a single dash.
func BytesBase64Var ¶
func BytesBase64Var(p *[]byte, name string, value []byte, usage string, validation ...func(value []byte) error)
BytesBase64Var defines an []byte flag with specified name, default value, and usage string. The argument p points to an []byte variable in which to store the value of the flag.
func BytesBase64VarP ¶
func BytesBase64VarP(p *[]byte, name, shorthand string, value []byte, usage string, validation ...func(value []byte) error)
BytesBase64VarP is like BytesBase64Var, but accepts a shorthand letter that can be used after a single dash.
func BytesHex ¶
func BytesHex(name string, value []byte, usage string, validation ...func(value []byte) error) *[]byte
BytesHex defines an []byte flag with specified name, default value, and usage string. The return value is the address of an []byte variable that stores the value of the flag.
func BytesHexP ¶
func BytesHexP(name, shorthand string, value []byte, usage string, validation ...func(value []byte) error) *[]byte
BytesHexP is like BytesHex, but accepts a shorthand letter that can be used after a single dash.
func BytesHexVar ¶
func BytesHexVar(p *[]byte, name string, value []byte, usage string, validation ...func(value []byte) error)
BytesHexVar defines an []byte flag with specified name, default value, and usage string. The argument p points to an []byte variable in which to store the value of the flag.
func BytesHexVarP ¶
func BytesHexVarP(p *[]byte, name, shorthand string, value []byte, usage string, validation ...func(value []byte) error)
BytesHexVarP is like BytesHexVar, but accepts a shorthand letter that can be used after a single dash.
func Count ¶
Count defines a count flag with specified name, default value, and usage string. The return value is the address of an int variable that stores the value of the flag. A count flag will add 1 to its value evey time it is found on the command line
func CountVar ¶
CountVar like CountVar only the flag is placed on the CommandLine instead of a given flag set
func Duration ¶
func Duration(name string, value time.Duration, usage string, validation ...func(value time.Duration) error) *time.Duration
Duration defines a time.Duration flag with specified name, default value, and usage string. The return value is the address of a time.Duration variable that stores the value of the flag.
func DurationP ¶
func DurationP(name, shorthand string, value time.Duration, usage string, validation ...func(value time.Duration) error) *time.Duration
DurationP is like Duration, but accepts a shorthand letter that can be used after a single dash.
func DurationSlice ¶
func DurationSlice(name string, value []time.Duration, usage string, validation ...func(value []time.Duration) error) *[]time.Duration
DurationSlice defines a []time.Duration flag with specified name, default value, and usage string. The return value is the address of a []time.Duration variable that stores the value of the flag.
func DurationSliceP ¶
func DurationSliceP(name, shorthand string, value []time.Duration, usage string, validation ...func(value []time.Duration) error) *[]time.Duration
DurationSliceP is like DurationSlice, but accepts a shorthand letter that can be used after a single dash.
func DurationSliceVar ¶
func DurationSliceVar(p *[]time.Duration, name string, value []time.Duration, usage string, validation ...func(value []time.Duration) error)
DurationSliceVar defines a duration[] flag with specified name, default value, and usage string. The argument p points to a duration[] variable in which to store the value of the flag.
func DurationSliceVarP ¶
func DurationSliceVarP(p *[]time.Duration, name, shorthand string, value []time.Duration, usage string, validation ...func(value []time.Duration) error)
DurationSliceVarP is like DurationSliceVar, but accepts a shorthand letter that can be used after a single dash.
func DurationVar ¶
func DurationVar(p *time.Duration, name string, value time.Duration, usage string, validation ...func(value time.Duration) error)
DurationVar defines a time.Duration flag with specified name, default value, and usage string. The argument p points to a time.Duration variable in which to store the value of the flag.
func DurationVarP ¶
func DurationVarP(p *time.Duration, name, shorthand string, value time.Duration, usage string, validation ...func(value time.Duration) error)
DurationVarP is like DurationVar, but accepts a shorthand letter that can be used after a single dash.
func Float32 ¶
func Float32(name string, value float32, usage string, validation ...func(value float32) error) *float32
Float32 defines a float32 flag with specified name, default value, and usage string. The return value is the address of a float32 variable that stores the value of the flag.
func Float32P ¶
func Float32P(name, shorthand string, value float32, usage string, validation ...func(value float32) error) *float32
Float32P is like Float32, but accepts a shorthand letter that can be used after a single dash.
func Float32Slice ¶
func Float32Slice(name string, value []float32, usage string, validation ...func(value []float32) error) *[]float32
Float32Slice defines a []float32 flag with specified name, default value, and usage string. The return value is the address of a []float32 variable that stores the value of the flag.
func Float32SliceP ¶
func Float32SliceP(name, shorthand string, value []float32, usage string, validation ...func(value []float32) error) *[]float32
Float32SliceP is like Float32Slice, but accepts a shorthand letter that can be used after a single dash.
func Float32SliceVar ¶
func Float32SliceVar(p *[]float32, name string, value []float32, usage string, validation ...func(value []float32) error)
Float32SliceVar defines a float32[] flag with specified name, default value, and usage string. The argument p points to a float32[] variable in which to store the value of the flag.
func Float32SliceVarP ¶
func Float32SliceVarP(p *[]float32, name, shorthand string, value []float32, usage string, validation ...func(value []float32) error)
Float32SliceVarP is like Float32SliceVar, but accepts a shorthand letter that can be used after a single dash.
func Float32Var ¶
func Float32Var(p *float32, name string, value float32, usage string, validation ...func(value float32) error)
Float32Var defines a float32 flag with specified name, default value, and usage string. The argument p points to a float32 variable in which to store the value of the flag.
func Float32VarP ¶
func Float32VarP(p *float32, name, shorthand string, value float32, usage string, validation ...func(value float32) error)
Float32VarP is like Float32Var, but accepts a shorthand letter that can be used after a single dash.
func Float64 ¶
func Float64(name string, value float64, usage string, validation ...func(value float64) error) *float64
Float64 defines a float64 flag with specified name, default value, and usage string. The return value is the address of a float64 variable that stores the value of the flag.
func Float64P ¶
func Float64P(name, shorthand string, value float64, usage string, validation ...func(value float64) error) *float64
Float64P is like Float64, but accepts a shorthand letter that can be used after a single dash.
func Float64Slice ¶
func Float64Slice(name string, value []float64, usage string, validation ...func(value []float64) error) *[]float64
Float64Slice defines a []float64 flag with specified name, default value, and usage string. The return value is the address of a []float64 variable that stores the value of the flag.
func Float64SliceP ¶
func Float64SliceP(name, shorthand string, value []float64, usage string, validation ...func(value []float64) error) *[]float64
Float64SliceP is like Float64Slice, but accepts a shorthand letter that can be used after a single dash.
func Float64SliceVar ¶
func Float64SliceVar(p *[]float64, name string, value []float64, usage string, validation ...func(value []float64) error)
Float64SliceVar defines a float64[] flag with specified name, default value, and usage string. The argument p points to a float64[] variable in which to store the value of the flag.
func Float64SliceVarP ¶
func Float64SliceVarP(p *[]float64, name, shorthand string, value []float64, usage string, validation ...func(value []float64) error)
Float64SliceVarP is like Float64SliceVar, but accepts a shorthand letter that can be used after a single dash.
func Float64Var ¶
func Float64Var(p *float64, name string, value float64, usage string, validation ...func(value float64) error)
Float64Var defines a float64 flag with specified name, default value, and usage string. The argument p points to a float64 variable in which to store the value of the flag.
func Float64VarP ¶
func Float64VarP(p *float64, name, shorthand string, value float64, usage string, validation ...func(value float64) error)
Float64VarP is like Float64Var, but accepts a shorthand letter that can be used after a single dash.
func IP ¶
IP defines an net.IP flag with specified name, default value, and usage string. The return value is the address of an net.IP variable that stores the value of the flag.
func IPMask ¶
func IPMask(name string, value net.IPMask, usage string, validation ...func(value net.IPMask) error) *net.IPMask
IPMask defines an net.IPMask flag with specified name, default value, and usage string. The return value is the address of an net.IPMask variable that stores the value of the flag.
func IPMaskP ¶
func IPMaskP(name, shorthand string, value net.IPMask, usage string, validation ...func(value net.IPMask) error) *net.IPMask
IPMaskP is like IP, but accepts a shorthand letter that can be used after a single dash.
func IPMaskVar ¶
func IPMaskVar(p *net.IPMask, name string, value net.IPMask, usage string, validation ...func(value net.IPMask) error)
IPMaskVar defines an net.IPMask flag with specified name, default value, and usage string. The argument p points to an net.IPMask variable in which to store the value of the flag.
func IPMaskVarP ¶
func IPMaskVarP(p *net.IPMask, name, shorthand string, value net.IPMask, usage string, validation ...func(value net.IPMask) error)
IPMaskVarP is like IPMaskVar, but accepts a shorthand letter that can be used after a single dash.
func IPNet ¶
func IPNet(name string, value net.IPNet, usage string, validation ...func(value net.IPNet) error) *net.IPNet
IPNet defines an net.IPNet flag with specified name, default value, and usage string. The return value is the address of an net.IPNet variable that stores the value of the flag.
func IPNetP ¶
func IPNetP(name, shorthand string, value net.IPNet, usage string, validation ...func(value net.IPNet) error) *net.IPNet
IPNetP is like IPNet, but accepts a shorthand letter that can be used after a single dash.
func IPNetSlice ¶
func IPNetSlice(name string, value []net.IPNet, usage string, validation ...func(value []net.IPNet) error) *[]net.IPNet
IPNetSlice defines a []net.IPNet flag with specified name, default value, and usage string. The return value is the address of a []net.IP variable that stores the value of the flag.
func IPNetSliceP ¶
func IPNetSliceP(name, shorthand string, value []net.IPNet, usage string, validation ...func(value []net.IPNet) error) *[]net.IPNet
IPNetSliceP is like IPNetSlice, but accepts a shorthand letter that can be used after a single dash.
func IPNetSliceVar ¶
func IPNetSliceVar(p *[]net.IPNet, name string, value []net.IPNet, usage string, validation ...func(value []net.IPNet) error)
IPNetSliceVar defines a []net.IPNet flag with specified name, default value, and usage string. The argument p points to a []net.IPNet variable in which to store the value of the flag.
func IPNetSliceVarP ¶
func IPNetSliceVarP(p *[]net.IPNet, name, shorthand string, value []net.IPNet, usage string, validation ...func(value []net.IPNet) error)
IPNetSliceVarP is like IPNetSliceVar, but accepts a shorthand letter that can be used after a single dash.
func IPNetVar ¶
func IPNetVar(p *net.IPNet, name string, value net.IPNet, usage string, validation ...func(value net.IPNet) error)
IPNetVar defines an net.IPNet flag with specified name, default value, and usage string. The argument p points to an net.IPNet variable in which to store the value of the flag.
func IPNetVarP ¶
func IPNetVarP(p *net.IPNet, name, shorthand string, value net.IPNet, usage string, validation ...func(value net.IPNet) error)
IPNetVarP is like IPNetVar, but accepts a shorthand letter that can be used after a single dash.
func IPP ¶
func IPP(name, shorthand string, value net.IP, usage string, validation ...func(value net.IP) error) *net.IP
IPP is like IP, but accepts a shorthand letter that can be used after a single dash.
func IPSlice ¶
func IPSlice(name string, value []net.IP, usage string, validation ...func(value []net.IP) error) *[]net.IP
IPSlice defines a []net.IP flag with specified name, default value, and usage string. The return value is the address of a []net.IP variable that stores the value of the flag.
func IPSliceP ¶
func IPSliceP(name, shorthand string, value []net.IP, usage string, validation ...func(value []net.IP) error) *[]net.IP
IPSliceP is like IPSlice, but accepts a shorthand letter that can be used after a single dash.
func IPSliceVar ¶
func IPSliceVar(p *[]net.IP, name string, value []net.IP, usage string, validation ...func(value []net.IP) error)
IPSliceVar defines a []net.IP flag with specified name, default value, and usage string. The argument p points to a []net.IP variable in which to store the value of the flag.
func IPSliceVarP ¶
func IPSliceVarP(p *[]net.IP, name, shorthand string, value []net.IP, usage string, validation ...func(value []net.IP) error)
IPSliceVarP is like IPSliceVar, but accepts a shorthand letter that can be used after a single dash.
func IPVar ¶
func IPVar(p *net.IP, name string, value net.IP, usage string, validation ...func(value net.IP) error)
IPVar defines an net.IP flag with specified name, default value, and usage string. The argument p points to an net.IP variable in which to store the value of the flag.
func IPVarP ¶
func IPVarP(p *net.IP, name, shorthand string, value net.IP, usage string, validation ...func(value net.IP) error)
IPVarP is like IPVar, but accepts a shorthand letter that can be used after a single dash.
func Int ¶
Int defines an int flag with specified name, default value, and usage string. The return value is the address of an int variable that stores the value of the flag.
func Int16 ¶
Int16 defines an int16 flag with specified name, default value, and usage string. The return value is the address of an int16 variable that stores the value of the flag.
func Int16P ¶
func Int16P(name, shorthand string, value int16, usage string, validation ...func(value int16) error) *int16
Int16P is like Int16, but accepts a shorthand letter that can be used after a single dash.
func Int16Var ¶
func Int16Var(p *int16, name string, value int16, usage string, validation ...func(value int16) error)
Int16Var defines an int16 flag with specified name, default value, and usage string. The argument p points to an int16 variable in which to store the value of the flag.
func Int16VarP ¶
func Int16VarP(p *int16, name, shorthand string, value int16, usage string, validation ...func(value int16) error)
Int16VarP is like Int16Var, but accepts a shorthand letter that can be used after a single dash.
func Int32 ¶
Int32 defines an int32 flag with specified name, default value, and usage string. The return value is the address of an int32 variable that stores the value of the flag.
func Int32P ¶
func Int32P(name, shorthand string, value int32, usage string, validation ...func(value int32) error) *int32
Int32P is like Int32, but accepts a shorthand letter that can be used after a single dash.
func Int32Slice ¶
func Int32Slice(name string, value []int32, usage string, validation ...func(value []int32) error) *[]int32
Int32Slice defines a []int32 flag with specified name, default value, and usage string. The return value is the address of a []int32 variable that stores the value of the flag.
func Int32SliceP ¶
func Int32SliceP(name, shorthand string, value []int32, usage string, validation ...func(value []int32) error) *[]int32
Int32SliceP is like Int32Slice, but accepts a shorthand letter that can be used after a single dash.
func Int32SliceVar ¶
func Int32SliceVar(p *[]int32, name string, value []int32, usage string, validation ...func(value []int32) error)
Int32SliceVar defines a int32[] flag with specified name, default value, and usage string. The argument p points to a int32[] variable in which to store the value of the flag.
func Int32SliceVarP ¶
func Int32SliceVarP(p *[]int32, name, shorthand string, value []int32, usage string, validation ...func(value []int32) error)
Int32SliceVarP is like Int32SliceVar, but accepts a shorthand letter that can be used after a single dash.
func Int32Var ¶
func Int32Var(p *int32, name string, value int32, usage string, validation ...func(value int32) error)
Int32Var defines an int32 flag with specified name, default value, and usage string. The argument p points to an int32 variable in which to store the value of the flag.
func Int32VarP ¶
func Int32VarP(p *int32, name, shorthand string, value int32, usage string, validation ...func(value int32) error)
Int32VarP is like Int32Var, but accepts a shorthand letter that can be used after a single dash.
func Int64 ¶
Int64 defines an int64 flag with specified name, default value, and usage string. The return value is the address of an int64 variable that stores the value of the flag.
func Int64P ¶
func Int64P(name, shorthand string, value int64, usage string, validation ...func(value int64) error) *int64
Int64P is like Int64, but accepts a shorthand letter that can be used after a single dash.
func Int64Slice ¶
func Int64Slice(name string, value []int64, usage string, validation ...func(value []int64) error) *[]int64
Int64Slice defines a []int64 flag with specified name, default value, and usage string. The return value is the address of a []int64 variable that stores the value of the flag.
func Int64SliceP ¶
func Int64SliceP(name, shorthand string, value []int64, usage string, validation ...func(value []int64) error) *[]int64
Int64SliceP is like Int64Slice, but accepts a shorthand letter that can be used after a single dash.
func Int64SliceVar ¶
func Int64SliceVar(p *[]int64, name string, value []int64, usage string, validation ...func(value []int64) error)
Int64SliceVar defines a int64[] flag with specified name, default value, and usage string. The argument p points to a int64[] variable in which to store the value of the flag.
func Int64SliceVarP ¶
func Int64SliceVarP(p *[]int64, name, shorthand string, value []int64, usage string, validation ...func(value []int64) error)
Int64SliceVarP is like Int64SliceVar, but accepts a shorthand letter that can be used after a single dash.
func Int64Var ¶
func Int64Var(p *int64, name string, value int64, usage string, validation ...func(value int64) error)
Int64Var defines an int64 flag with specified name, default value, and usage string. The argument p points to an int64 variable in which to store the value of the flag.
func Int64VarP ¶
func Int64VarP(p *int64, name, shorthand string, value int64, usage string, validation ...func(value int64) error)
Int64VarP is like Int64Var, but accepts a shorthand letter that can be used after a single dash.
func Int8 ¶
Int8 defines an int8 flag with specified name, default value, and usage string. The return value is the address of an int8 variable that stores the value of the flag.
func Int8P ¶
func Int8P(name, shorthand string, value int8, usage string, validation ...func(value int8) error) *int8
Int8P is like Int8, but accepts a shorthand letter that can be used after a single dash.
func Int8Var ¶
Int8Var defines an int8 flag with specified name, default value, and usage string. The argument p points to an int8 variable in which to store the value of the flag.
func Int8VarP ¶
func Int8VarP(p *int8, name, shorthand string, value int8, usage string, validation ...func(value int8) error)
Int8VarP is like Int8Var, but accepts a shorthand letter that can be used after a single dash.
func IntP ¶
func IntP(name, shorthand string, value int, usage string, validation ...func(value int) error) *int
IntP is like Int, but accepts a shorthand letter that can be used after a single dash.
func IntSlice ¶
IntSlice defines a []int flag with specified name, default value, and usage string. The return value is the address of a []int variable that stores the value of the flag.
func IntSliceP ¶
func IntSliceP(name, shorthand string, value []int, usage string, validation ...func(value []int) error) *[]int
IntSliceP is like IntSlice, but accepts a shorthand letter that can be used after a single dash.
func IntSliceVar ¶
func IntSliceVar(p *[]int, name string, value []int, usage string, validation ...func(value []int) error)
IntSliceVar defines a int[] flag with specified name, default value, and usage string. The argument p points to a int[] variable in which to store the value of the flag.
func IntSliceVarP ¶
func IntSliceVarP(p *[]int, name, shorthand string, value []int, usage string, validation ...func(value []int) error)
IntSliceVarP is like IntSliceVar, but accepts a shorthand letter that can be used after a single dash.
func IntVar ¶
IntVar defines an int flag with specified name, default value, and usage string. The argument p points to an int variable in which to store the value of the flag.
func IntVarP ¶
func IntVarP(p *int, name, shorthand string, value int, usage string, validation ...func(value int) error)
IntVarP is like IntVar, but accepts a shorthand letter that can be used after a single dash.
func NArg ¶
func NArg() int
NArg is the number of arguments remaining after flags have been processed.
func Parse ¶
func Parse()
Parse parses the command-line flags from os.Args[1:]. Must be called after all flags are defined and before flags are accessed by the program.
func ParseAll ¶
ParseAll parses the command-line flags from os.Args[1:] and called fn for each. The arguments for fn are flag and value. Must be called after all flags are defined and before flags are accessed by the program.
func ParseIPv4Mask ¶
ParseIPv4Mask written in IP form (e.g. 255.255.255.0). This function should really belong to the net package.
func PrintDefaults ¶
func PrintDefaults()
PrintDefaults prints to standard error the default values of all defined command-line flags.
func SetInterspersed ¶
func SetInterspersed(interspersed bool)
SetInterspersed sets whether to support interspersed option/non-option arguments.
func String ¶
func String(name string, value string, usage string, validation ...func(value string) error) *string
String defines a string flag with specified name, default value, and usage string. The return value is the address of a string variable that stores the value of the flag.
func StringArray ¶
func StringArray(name string, value []string, usage string, validation ...func(value []string) error) *[]string
StringArray defines a string flag with specified name, default value, and usage string. The return value is the address of a []string variable that stores the value of the flag. The value of each argument will not try to be separated by comma. Use a StringSlice for that.
func StringArrayP ¶
func StringArrayP(name, shorthand string, value []string, usage string, validation ...func(value []string) error) *[]string
StringArrayP is like StringArray, but accepts a shorthand letter that can be used after a single dash.
func StringArrayVar ¶
func StringArrayVar(p *[]string, name string, value []string, usage string, validation ...func(value []string) error)
StringArrayVar defines a string flag with specified name, default value, and usage string. The argument p points to a []string variable in which to store the value of the flag. The value of each argument will not try to be separated by comma. Use a StringSlice for that.
func StringArrayVarP ¶
func StringArrayVarP(p *[]string, name, shorthand string, value []string, usage string, validation ...func(value []string) error)
StringArrayVarP is like StringArrayVar, but accepts a shorthand letter that can be used after a single dash.
func StringP ¶
func StringP(name, shorthand string, value string, usage string, validation ...func(value string) error) *string
StringP is like String, but accepts a shorthand letter that can be used after a single dash.
func StringSlice ¶
func StringSlice(name string, value []string, usage string, validation ...func(value []string) error) *[]string
StringSlice defines a string flag with specified name, default value, and usage string. The return value is the address of a []string variable that stores the value of the flag. Compared to StringArray flags, StringSlice flags take comma-separated value as arguments and split them accordingly. For example:
--ss="v1,v2" --ss="v3"
will result in
[]string{"v1", "v2", "v3"}
func StringSliceP ¶
func StringSliceP(name, shorthand string, value []string, usage string, validation ...func(value []string) error) *[]string
StringSliceP is like StringSlice, but accepts a shorthand letter that can be used after a single dash.
func StringSliceVar ¶
func StringSliceVar(p *[]string, name string, value []string, usage string, validation ...func(value []string) error)
StringSliceVar defines a string flag with specified name, default value, and usage string. The argument p points to a []string variable in which to store the value of the flag. Compared to StringArray flags, StringSlice flags take comma-separated value as arguments and split them accordingly. For example:
--ss="v1,v2" --ss="v3"
will result in
[]string{"v1", "v2", "v3"}
func StringSliceVarP ¶
func StringSliceVarP(p *[]string, name, shorthand string, value []string, usage string, validation ...func(value []string) error)
StringSliceVarP is like StringSliceVar, but accepts a shorthand letter that can be used after a single dash.
func StringToInt ¶
func StringToInt(name string, value map[string]int, usage string, validation ...func(value map[string]int) error) *map[string]int
StringToInt defines a string flag with specified name, default value, and usage string. The return value is the address of a map[string]int variable that stores the value of the flag. The value of each argument will not try to be separated by comma
func StringToInt64 ¶
func StringToInt64(name string, value map[string]int64, usage string, validation ...func(value map[string]int64) error) *map[string]int64
StringToInt64 defines a string flag with specified name, default value, and usage string. The return value is the address of a map[string]int64 variable that stores the value of the flag. The value of each argument will not try to be separated by comma
func StringToInt64P ¶
func StringToInt64P(name, shorthand string, value map[string]int64, usage string, validation ...func(value map[string]int64) error) *map[string]int64
StringToInt64P is like StringToInt64, but accepts a shorthand letter that can be used after a single dash.
func StringToInt64Var ¶
func StringToInt64Var(p *map[string]int64, name string, value map[string]int64, usage string, validation ...func(value map[string]int64) error)
StringToInt64Var defines a string flag with specified name, default value, and usage string. The argument p point64s to a map[string]int64 variable in which to store the value of the flag. The value of each argument will not try to be separated by comma
func StringToInt64VarP ¶
func StringToInt64VarP(p *map[string]int64, name, shorthand string, value map[string]int64, usage string, validation ...func(value map[string]int64) error)
StringToInt64VarP is like StringToInt64Var, but accepts a shorthand letter that can be used after a single dash.
func StringToIntP ¶
func StringToIntP(name, shorthand string, value map[string]int, usage string, validation ...func(value map[string]int) error) *map[string]int
StringToIntP is like StringToInt, but accepts a shorthand letter that can be used after a single dash.
func StringToIntVar ¶
func StringToIntVar(p *map[string]int, name string, value map[string]int, usage string, validation ...func(value map[string]int) error)
StringToIntVar defines a string flag with specified name, default value, and usage string. The argument p points to a map[string]int variable in which to store the value of the flag. The value of each argument will not try to be separated by comma
func StringToIntVarP ¶
func StringToIntVarP(p *map[string]int, name, shorthand string, value map[string]int, usage string, validation ...func(value map[string]int) error)
StringToIntVarP is like StringToIntVar, but accepts a shorthand letter that can be used after a single dash.
func StringToString ¶
func StringToString(name string, value map[string]string, usage string, validation ...func(value map[string]string) error) *map[string]string
StringToString defines a string flag with specified name, default value, and usage string. The return value is the address of a map[string]string variable that stores the value of the flag. The value of each argument will not try to be separated by comma
func StringToStringP ¶
func StringToStringP(name, shorthand string, value map[string]string, usage string, validation ...func(value map[string]string) error) *map[string]string
StringToStringP is like StringToString, but accepts a shorthand letter that can be used after a single dash.
func StringToStringVar ¶
func StringToStringVar(p *map[string]string, name string, value map[string]string, usage string, validation ...func(value map[string]string) error)
StringToStringVar defines a string flag with specified name, default value, and usage string. The argument p points to a map[string]string variable in which to store the value of the flag. The value of each argument will not try to be separated by comma
func StringToStringVarP ¶
func StringToStringVarP(p *map[string]string, name, shorthand string, value map[string]string, usage string, validation ...func(value map[string]string) error)
StringToStringVarP is like StringToStringVar, but accepts a shorthand letter that can be used after a single dash.
func StringVar ¶
func StringVar(p *string, name string, value string, usage string, validation ...func(value string) error)
StringVar defines a string flag with specified name, default value, and usage string. The argument p points to a string variable in which to store the value of the flag.
func StringVarP ¶
func StringVarP(p *string, name, shorthand string, value string, usage string, validation ...func(value string) error)
StringVarP is like StringVar, but accepts a shorthand letter that can be used after a single dash.
func Uint ¶
Uint defines a uint flag with specified name, default value, and usage string. The return value is the address of a uint variable that stores the value of the flag.
func Uint16 ¶
func Uint16(name string, value uint16, usage string, validation ...func(value uint16) error) *uint16
Uint16 defines a uint flag with specified name, default value, and usage string. The return value is the address of a uint variable that stores the value of the flag.
func Uint16P ¶
func Uint16P(name, shorthand string, value uint16, usage string, validation ...func(value uint16) error) *uint16
Uint16P is like Uint16, but accepts a shorthand letter that can be used after a single dash.
func Uint16Var ¶
func Uint16Var(p *uint16, name string, value uint16, usage string, validation ...func(value uint16) error)
Uint16Var defines a uint flag with specified name, default value, and usage string. The argument p points to a uint variable in which to store the value of the flag.
func Uint16VarP ¶
func Uint16VarP(p *uint16, name, shorthand string, value uint16, usage string, validation ...func(value uint16) error)
Uint16VarP is like Uint16Var, but accepts a shorthand letter that can be used after a single dash.
func Uint32 ¶
func Uint32(name string, value uint32, usage string, validation ...func(value uint32) error) *uint32
Uint32 defines a uint32 flag with specified name, default value, and usage string. The return value is the address of a uint32 variable that stores the value of the flag.
func Uint32P ¶
func Uint32P(name, shorthand string, value uint32, usage string, validation ...func(value uint32) error) *uint32
Uint32P is like Uint32, but accepts a shorthand letter that can be used after a single dash.
func Uint32Var ¶
func Uint32Var(p *uint32, name string, value uint32, usage string, validation ...func(value uint32) error)
Uint32Var defines a uint32 flag with specified name, default value, and usage string. The argument p points to a uint32 variable in which to store the value of the flag.
func Uint32VarP ¶
func Uint32VarP(p *uint32, name, shorthand string, value uint32, usage string, validation ...func(value uint32) error)
Uint32VarP is like Uint32Var, but accepts a shorthand letter that can be used after a single dash.
func Uint64 ¶
func Uint64(name string, value uint64, usage string, validation ...func(value uint64) error) *uint64
Uint64 defines a uint64 flag with specified name, default value, and usage string. The return value is the address of a uint64 variable that stores the value of the flag.
func Uint64P ¶
func Uint64P(name, shorthand string, value uint64, usage string, validation ...func(value uint64) error) *uint64
Uint64P is like Uint64, but accepts a shorthand letter that can be used after a single dash.
func Uint64Var ¶
func Uint64Var(p *uint64, name string, value uint64, usage string, validation ...func(value uint64) error)
Uint64Var defines a uint64 flag with specified name, default value, and usage string. The argument p points to a uint64 variable in which to store the value of the flag.
func Uint64VarP ¶
func Uint64VarP(p *uint64, name, shorthand string, value uint64, usage string, validation ...func(value uint64) error)
Uint64VarP is like Uint64Var, but accepts a shorthand letter that can be used after a single dash.
func Uint8 ¶
Uint8 defines a uint8 flag with specified name, default value, and usage string. The return value is the address of a uint8 variable that stores the value of the flag.
func Uint8P ¶
func Uint8P(name, shorthand string, value uint8, usage string, validation ...func(value uint8) error) *uint8
Uint8P is like Uint8, but accepts a shorthand letter that can be used after a single dash.
func Uint8Var ¶
func Uint8Var(p *uint8, name string, value uint8, usage string, validation ...func(value uint8) error)
Uint8Var defines a uint8 flag with specified name, default value, and usage string. The argument p points to a uint8 variable in which to store the value of the flag.
func Uint8VarP ¶
func Uint8VarP(p *uint8, name, shorthand string, value uint8, usage string, validation ...func(value uint8) error)
Uint8VarP is like Uint8Var, but accepts a shorthand letter that can be used after a single dash.
func UintP ¶
func UintP(name, shorthand string, value uint, usage string, validation ...func(value uint) error) *uint
UintP is like Uint, but accepts a shorthand letter that can be used after a single dash.
func UintSlice ¶
func UintSlice(name string, value []uint, usage string, validation ...func(value []uint) error) *[]uint
UintSlice defines a []uint flag with specified name, default value, and usage string. The return value is the address of a []uint variable that stores the value of the flag.
func UintSliceP ¶
func UintSliceP(name, shorthand string, value []uint, usage string, validation ...func(value []uint) error) *[]uint
UintSliceP is like UintSlice, but accepts a shorthand letter that can be used after a single dash.
func UintSliceVar ¶
func UintSliceVar(p *[]uint, name string, value []uint, usage string, validation ...func(value []uint) error)
UintSliceVar defines a uint[] flag with specified name, default value, and usage string. The argument p points to a uint[] variable in which to store the value of the flag.
func UintSliceVarP ¶
func UintSliceVarP(p *[]uint, name, shorthand string, value []uint, usage string, validation ...func(value []uint) error)
UintSliceVarP is like the UintSliceVar, but accepts a shorthand letter that can be used after a single dash.
func UintVar ¶
UintVar defines a uint flag with specified name, default value, and usage string. The argument p points to a uint variable in which to store the value of the flag.
func UintVarP ¶
func UintVarP(p *uint, name, shorthand string, value uint, usage string, validation ...func(value uint) error)
UintVarP is like UintVar, but accepts a shorthand letter that can be used after a single dash.
func UnquoteUsage ¶
UnquoteUsage extracts a back-quoted name from the usage string for a flag and returns it and the un-quoted usage. Given "a `name` to show" it returns ("name", "a name to show"). If there are no back quotes, the name is an educated guess of the type of the flag's value, or the empty string if the flag is boolean.
func Var ¶
Var defines a flag with the specified name and usage string. The type and value of the flag are represented by the first argument, of type Value, which typically holds a user-defined implementation of Value. For instance, the caller could create a flag that turns a comma-separated string into a slice of strings by giving the slice the methods of Value; in particular, Set would decompose the comma-separated string into the slice.
Types ¶
type ErrorHandling ¶
type ErrorHandling int
ErrorHandling defines how to handle flag parsing errors.
const ( // ContinueOnError will return an err from Parse() if an error is found ContinueOnError ErrorHandling = iota // ExitOnError will call os.Exit(2) if an error is found when parsing ExitOnError // PanicOnError will panic() if an error is found when parsing flags PanicOnError )
type Flag ¶
type Flag struct { Name string // name as it appears on command line Shorthand string // one-letter abbreviated flag Usage string // help message Value Value // value as set DefValue string // default value (as text); for usage message Changed bool // If the user set the value (or if left to default) NoOptDefVal string // default value (as text); if the flag is on the command line without any options Deprecated string // If this flag is deprecated, this string is the new or now thing to use Hidden bool // used by cobra.Command to allow flags to be hidden from help/usage text ShorthandDeprecated string // If the shorthand of this flag is deprecated, this string is the new or now thing to use Annotations map[string][]string // used by cobra.Command bash autocomple code Validation interface{} // If you want to add custom validation for the value of the flag }
A Flag represents the state of a flag.
func Lookup ¶
Lookup returns the Flag structure of the named command-line flag, returning nil if none exists.
func PFlagFromGoFlag ¶
PFlagFromGoFlag will return a *pflag.Flag given a *flag.Flag If the *flag.Flag.Name was a single character (ex: `v`) it will be accessiblei with both `-v` and `--v` in flags. If the golang flag was more than a single character (ex: `verbose`) it will only be accessible via `--verbose`
func ShorthandLookup ¶
ShorthandLookup returns the Flag structure of the short handed flag, returning nil if none exists.
Example ¶
package main import ( "fmt" "github.com/erfanmomeniii/pflag" ) func main() { name := "verbose" short := name[:1] pflag.BoolP(name, short, false, "verbose output") // len(short) must be == 1 flag := pflag.ShorthandLookup(short) fmt.Println(flag.Name) }
Output:
type FlagSet ¶
type FlagSet struct { // Usage is the function called when an error occurs while parsing flags. // The field is a function (not a method) that may be changed to point to // a custom error handler. Usage func() // SortFlags is used to indicate, if user wants to have sorted flags in // help/usage messages. SortFlags bool // ParseErrorsWhitelist is used to configure a whitelist of errors ParseErrorsWhitelist ParseErrorsWhitelist // contains filtered or unexported fields }
A FlagSet represents a set of defined flags.
func NewFlagSet ¶
func NewFlagSet(name string, errorHandling ErrorHandling) *FlagSet
NewFlagSet returns a new, empty flag set with the specified name, error handling property and SortFlags set to true.
func (*FlagSet) AddFlagSet ¶
AddFlagSet adds one FlagSet to another. If a flag is already present in f the flag from newSet will be ignored.
func (*FlagSet) AddGoFlagSet ¶
AddGoFlagSet will add the given *flag.FlagSet to the pflag.FlagSet
func (*FlagSet) Arg ¶
Arg returns the i'th argument. Arg(0) is the first remaining argument after flags have been processed.
func (*FlagSet) ArgsLenAtDash ¶
ArgsLenAtDash will return the length of f.Args at the moment when a -- was found during arg parsing. This allows your program to know which args were before the -- and which came after.
func (*FlagSet) Bool ¶
func (f *FlagSet) Bool(name string, value bool, usage string, validation ...func(value bool) error) *bool
Bool defines a bool flag with specified name, default value, and usage string. The return value is the address of a bool variable that stores the value of the flag.
func (*FlagSet) BoolP ¶
func (f *FlagSet) BoolP(name, shorthand string, value bool, usage string, validation ...func(value bool) error) *bool
BoolP is like Bool, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) BoolSlice ¶
func (f *FlagSet) BoolSlice(name string, value []bool, usage string, validation ...func(value []bool) error) *[]bool
BoolSlice defines a []bool flag with specified name, default value, and usage string. The return value is the address of a []bool variable that stores the value of the flag.
func (*FlagSet) BoolSliceP ¶
func (f *FlagSet) BoolSliceP(name, shorthand string, value []bool, usage string, validation ...func(value []bool) error) *[]bool
BoolSliceP is like BoolSlice, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) BoolSliceVar ¶
func (f *FlagSet) BoolSliceVar(p *[]bool, name string, value []bool, usage string, validation ...func(value []bool) error)
BoolSliceVar defines a boolSlice flag with specified name, default value, and usage string. The argument p points to a []bool variable in which to store the value of the flag.
func (*FlagSet) BoolSliceVarP ¶
func (f *FlagSet) BoolSliceVarP(p *[]bool, name, shorthand string, value []bool, usage string, validation ...func(value []bool) error)
BoolSliceVarP is like BoolSliceVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) BoolVar ¶
func (f *FlagSet) BoolVar(p *bool, name string, value bool, usage string, validation ...func(value bool) error)
BoolVar defines a bool flag with specified name, default value, and usage string. The argument p points to a bool variable in which to store the value of the flag.
func (*FlagSet) BoolVarP ¶
func (f *FlagSet) BoolVarP(p *bool, name, shorthand string, value bool, usage string, validation ...func(value bool) error)
BoolVarP is like BoolVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) BytesBase64 ¶
func (f *FlagSet) BytesBase64(name string, value []byte, usage string, validation ...func(value []byte) error) *[]byte
BytesBase64 defines an []byte flag with specified name, default value, and usage string. The return value is the address of an []byte variable that stores the value of the flag.
func (*FlagSet) BytesBase64P ¶
func (f *FlagSet) BytesBase64P(name, shorthand string, value []byte, usage string, validation ...func(value []byte) error) *[]byte
BytesBase64P is like BytesBase64, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) BytesBase64Var ¶
func (f *FlagSet) BytesBase64Var(p *[]byte, name string, value []byte, usage string, validation ...func(value []byte) error)
BytesBase64Var defines an []byte flag with specified name, default value, and usage string. The argument p points to an []byte variable in which to store the value of the flag.
func (*FlagSet) BytesBase64VarP ¶
func (f *FlagSet) BytesBase64VarP(p *[]byte, name, shorthand string, value []byte, usage string, validation ...func(value []byte) error)
BytesBase64VarP is like BytesBase64Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) BytesHex ¶
func (f *FlagSet) BytesHex(name string, value []byte, usage string, validation ...func(value []byte) error) *[]byte
BytesHex defines an []byte flag with specified name, default value, and usage string. The return value is the address of an []byte variable that stores the value of the flag.
func (*FlagSet) BytesHexP ¶
func (f *FlagSet) BytesHexP(name, shorthand string, value []byte, usage string, validation ...func(value []byte) error) *[]byte
BytesHexP is like BytesHex, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) BytesHexVar ¶
func (f *FlagSet) BytesHexVar(p *[]byte, name string, value []byte, usage string, validation ...func(value []byte) error)
BytesHexVar defines an []byte flag with specified name, default value, and usage string. The argument p points to an []byte variable in which to store the value of the flag.
func (*FlagSet) BytesHexVarP ¶
func (f *FlagSet) BytesHexVarP(p *[]byte, name, shorthand string, value []byte, usage string, validation ...func(value []byte) error)
BytesHexVarP is like BytesHexVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Changed ¶
Changed returns true if the flag was explicitly set during Parse() and false otherwise
func (*FlagSet) Count ¶
Count defines a count flag with specified name, default value, and usage string. The return value is the address of an int variable that stores the value of the flag. A count flag will add 1 to its value every time it is found on the command line
func (*FlagSet) CountP ¶
func (f *FlagSet) CountP(name, shorthand string, usage string, validation ...func(value int) error) *int
CountP is like Count only takes a shorthand for the flag name.
func (*FlagSet) CountVar ¶
CountVar defines a count flag with specified name, default value, and usage string. The argument p points to an int variable in which to store the value of the flag. A count flag will add 1 to its value every time it is found on the command line
func (*FlagSet) CountVarP ¶
func (f *FlagSet) CountVarP(p *int, name, shorthand string, usage string, validation ...func(value int) error)
CountVarP is like CountVar only take a shorthand for the flag name.
func (*FlagSet) Duration ¶
func (f *FlagSet) Duration(name string, value time.Duration, usage string, validation ...func(value time.Duration) error) *time.Duration
Duration defines a time.Duration flag with specified name, default value, and usage string. The return value is the address of a time.Duration variable that stores the value of the flag.
func (*FlagSet) DurationP ¶
func (f *FlagSet) DurationP(name, shorthand string, value time.Duration, usage string, validation ...func(value time.Duration) error) *time.Duration
DurationP is like Duration, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) DurationSlice ¶
func (f *FlagSet) DurationSlice(name string, value []time.Duration, usage string, validation ...func(value []time.Duration) error) *[]time.Duration
DurationSlice defines a []time.Duration flag with specified name, default value, and usage string. The return value is the address of a []time.Duration variable that stores the value of the flag.
func (*FlagSet) DurationSliceP ¶
func (f *FlagSet) DurationSliceP(name, shorthand string, value []time.Duration, usage string, validation ...func(value []time.Duration) error) *[]time.Duration
DurationSliceP is like DurationSlice, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) DurationSliceVar ¶
func (f *FlagSet) DurationSliceVar(p *[]time.Duration, name string, value []time.Duration, usage string, validation ...func(value []time.Duration) error)
DurationSliceVar defines a durationSlice flag with specified name, default value, and usage string. The argument p points to a []time.Duration variable in which to store the value of the flag.
func (*FlagSet) DurationSliceVarP ¶
func (f *FlagSet) DurationSliceVarP(p *[]time.Duration, name, shorthand string, value []time.Duration, usage string, validation ...func(value []time.Duration) error)
DurationSliceVarP is like DurationSliceVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) DurationVar ¶
func (f *FlagSet) DurationVar(p *time.Duration, name string, value time.Duration, usage string, validation ...func(value time.Duration) error)
DurationVar defines a time.Duration flag with specified name, default value, and usage string. The argument p points to a time.Duration variable in which to store the value of the flag.
func (*FlagSet) DurationVarP ¶
func (f *FlagSet) DurationVarP(p *time.Duration, name, shorthand string, value time.Duration, usage string, validation ...func(value time.Duration) error)
DurationVarP is like DurationVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) FlagUsages ¶
FlagUsages returns a string containing the usage information for all flags in the FlagSet
func (*FlagSet) FlagUsagesWrapped ¶
FlagUsagesWrapped returns a string containing the usage information for all flags in the FlagSet. Wrapped to `cols` columns (0 for no wrapping)
func (*FlagSet) Float32 ¶
func (f *FlagSet) Float32(name string, value float32, usage string, validation ...func(value float32) error) *float32
Float32 defines a float32 flag with specified name, default value, and usage string. The return value is the address of a float32 variable that stores the value of the flag.
func (*FlagSet) Float32P ¶
func (f *FlagSet) Float32P(name, shorthand string, value float32, usage string, validation ...func(value float32) error) *float32
Float32P is like Float32, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Float32Slice ¶
func (f *FlagSet) Float32Slice(name string, value []float32, usage string, validation ...func(value []float32) error) *[]float32
Float32Slice defines a []float32 flag with specified name, default value, and usage string. The return value is the address of a []float32 variable that stores the value of the flag.
func (*FlagSet) Float32SliceP ¶
func (f *FlagSet) Float32SliceP(name, shorthand string, value []float32, usage string, validation ...func(value []float32) error) *[]float32
Float32SliceP is like Float32Slice, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Float32SliceVar ¶
func (f *FlagSet) Float32SliceVar(p *[]float32, name string, value []float32, usage string, validation ...func(value []float32) error)
Float32SliceVar defines a float32Slice flag with specified name, default value, and usage string. The argument p points to a []float32 variable in which to store the value of the flag.
func (*FlagSet) Float32SliceVarP ¶
func (f *FlagSet) Float32SliceVarP(p *[]float32, name, shorthand string, value []float32, usage string, validation ...func(value []float32) error)
Float32SliceVarP is like Float32SliceVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Float32Var ¶
func (f *FlagSet) Float32Var(p *float32, name string, value float32, usage string, validation ...func(value float32) error)
Float32Var defines a float32 flag with specified name, default value, and usage string. The argument p points to a float32 variable in which to store the value of the flag.
func (*FlagSet) Float32VarP ¶
func (f *FlagSet) Float32VarP(p *float32, name, shorthand string, value float32, usage string, validation ...func(value float32) error)
Float32VarP is like Float32Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Float64 ¶
func (f *FlagSet) Float64(name string, value float64, usage string, validation ...func(value float64) error) *float64
Float64 defines a float64 flag with specified name, default value, and usage string. The return value is the address of a float64 variable that stores the value of the flag.
func (*FlagSet) Float64P ¶
func (f *FlagSet) Float64P(name, shorthand string, value float64, usage string, validation ...func(value float64) error) *float64
Float64P is like Float64, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Float64Slice ¶
func (f *FlagSet) Float64Slice(name string, value []float64, usage string, validation ...func(value []float64) error) *[]float64
Float64Slice defines a []float64 flag with specified name, default value, and usage string. The return value is the address of a []float64 variable that stores the value of the flag.
func (*FlagSet) Float64SliceP ¶
func (f *FlagSet) Float64SliceP(name, shorthand string, value []float64, usage string, validation ...func(value []float64) error) *[]float64
Float64SliceP is like Float64Slice, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Float64SliceVar ¶
func (f *FlagSet) Float64SliceVar(p *[]float64, name string, value []float64, usage string, validation ...func(value []float64) error)
Float64SliceVar defines a float64Slice flag with specified name, default value, and usage string. The argument p points to a []float64 variable in which to store the value of the flag.
func (*FlagSet) Float64SliceVarP ¶
func (f *FlagSet) Float64SliceVarP(p *[]float64, name, shorthand string, value []float64, usage string, validation ...func(value []float64) error)
Float64SliceVarP is like Float64SliceVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Float64Var ¶
func (f *FlagSet) Float64Var(p *float64, name string, value float64, usage string, validation ...func(value float64) error)
Float64Var defines a float64 flag with specified name, default value, and usage string. The argument p points to a float64 variable in which to store the value of the flag.
func (*FlagSet) Float64VarP ¶
func (f *FlagSet) Float64VarP(p *float64, name, shorthand string, value float64, usage string, validation ...func(value float64) error)
Float64VarP is like Float64Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) GetBoolSlice ¶
GetBoolSlice returns the []bool value of a flag with the given name.
func (*FlagSet) GetBytesBase64 ¶
GetBytesBase64 return the []byte value of a flag with the given name
func (*FlagSet) GetBytesHex ¶
GetBytesHex return the []byte value of a flag with the given name
func (*FlagSet) GetDuration ¶
GetDuration return the duration value of a flag with the given name
func (*FlagSet) GetDurationSlice ¶
GetDurationSlice returns the []time.Duration value of a flag with the given name
func (*FlagSet) GetFloat32 ¶
GetFloat32 return the float32 value of a flag with the given name
func (*FlagSet) GetFloat32Slice ¶
GetFloat32Slice return the []float32 value of a flag with the given name
func (*FlagSet) GetFloat64 ¶
GetFloat64 return the float64 value of a flag with the given name
func (*FlagSet) GetFloat64Slice ¶
GetFloat64Slice return the []float64 value of a flag with the given name
func (*FlagSet) GetIPNetSlice ¶
GetIPNetSlice returns the []net.IPNet value of a flag with the given name
func (*FlagSet) GetIPSlice ¶
GetIPSlice returns the []net.IP value of a flag with the given name
func (*FlagSet) GetIPv4Mask ¶
GetIPv4Mask return the net.IPv4Mask value of a flag with the given name
func (*FlagSet) GetInt32Slice ¶
GetInt32Slice return the []int32 value of a flag with the given name
func (*FlagSet) GetInt64Slice ¶
GetInt64Slice return the []int64 value of a flag with the given name
func (*FlagSet) GetIntSlice ¶
GetIntSlice return the []int value of a flag with the given name
func (*FlagSet) GetNormalizeFunc ¶
func (f *FlagSet) GetNormalizeFunc() func(f *FlagSet, name string) NormalizedName
GetNormalizeFunc returns the previously set NormalizeFunc of a function which does no translation, if not set previously.
func (*FlagSet) GetStringArray ¶
GetStringArray return the []string value of a flag with the given name
func (*FlagSet) GetStringSlice ¶
GetStringSlice return the []string value of a flag with the given name
func (*FlagSet) GetStringToInt ¶
GetStringToInt return the map[string]int value of a flag with the given name
func (*FlagSet) GetStringToInt64 ¶
GetStringToInt64 return the map[string]int64 value of a flag with the given name
func (*FlagSet) GetStringToString ¶
GetStringToString return the map[string]string value of a flag with the given name
func (*FlagSet) GetUintSlice ¶
GetUintSlice returns the []uint value of a flag with the given name.
func (*FlagSet) HasAvailableFlags ¶
HasAvailableFlags returns a bool to indicate if the FlagSet has any flags that are not hidden.
func (*FlagSet) HasFlags ¶
HasFlags returns a bool to indicate if the FlagSet has any flags defined.
func (*FlagSet) IP ¶
func (f *FlagSet) IP(name string, value net.IP, usage string, validation ...func(value net.IP) error) *net.IP
IP defines an net.IP flag with specified name, default value, and usage string. The return value is the address of an net.IP variable that stores the value of the flag.
func (*FlagSet) IPMask ¶
func (f *FlagSet) IPMask(name string, value net.IPMask, usage string, validation ...func(value net.IPMask) error) *net.IPMask
IPMask defines an net.IPMask flag with specified name, default value, and usage string. The return value is the address of an net.IPMask variable that stores the value of the flag.
func (*FlagSet) IPMaskP ¶
func (f *FlagSet) IPMaskP(name, shorthand string, value net.IPMask, usage string, validation ...func(value net.IPMask) error) *net.IPMask
IPMaskP is like IPMask, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IPMaskVar ¶
func (f *FlagSet) IPMaskVar(p *net.IPMask, name string, value net.IPMask, usage string, validation ...func(value net.IPMask) error)
IPMaskVar defines an net.IPMask flag with specified name, default value, and usage string. The argument p points to an net.IPMask variable in which to store the value of the flag.
func (*FlagSet) IPMaskVarP ¶
func (f *FlagSet) IPMaskVarP(p *net.IPMask, name, shorthand string, value net.IPMask, usage string, validation ...func(value net.IPMask) error)
IPMaskVarP is like IPMaskVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IPNet ¶
func (f *FlagSet) IPNet(name string, value net.IPNet, usage string, validation ...func(value net.IPNet) error) *net.IPNet
IPNet defines an net.IPNet flag with specified name, default value, and usage string. The return value is the address of an net.IPNet variable that stores the value of the flag.
func (*FlagSet) IPNetP ¶
func (f *FlagSet) IPNetP(name, shorthand string, value net.IPNet, usage string, validation ...func(value net.IPNet) error) *net.IPNet
IPNetP is like IPNet, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IPNetSlice ¶
func (f *FlagSet) IPNetSlice(name string, value []net.IPNet, usage string, validation ...func(value []net.IPNet) error) *[]net.IPNet
IPNetSlice defines a []net.IPNet flag with specified name, default value, and usage string. The return value is the address of a []net.IPNet variable that stores the value of that flag.
func (*FlagSet) IPNetSliceP ¶
func (f *FlagSet) IPNetSliceP(name, shorthand string, value []net.IPNet, usage string, validation ...func(value []net.IPNet) error) *[]net.IPNet
IPNetSliceP is like IPNetSlice, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IPNetSliceVar ¶
func (f *FlagSet) IPNetSliceVar(p *[]net.IPNet, name string, value []net.IPNet, usage string, validation ...func(value []net.IPNet) error)
IPNetSliceVar defines a ipNetSlice flag with specified name, default value, and usage string. The argument p points to a []net.IPNet variable in which to store the value of the flag.
func (*FlagSet) IPNetSliceVarP ¶
func (f *FlagSet) IPNetSliceVarP(p *[]net.IPNet, name, shorthand string, value []net.IPNet, usage string, validation ...func(value []net.IPNet) error)
IPNetSliceVarP is like IPNetSliceVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IPNetVar ¶
func (f *FlagSet) IPNetVar(p *net.IPNet, name string, value net.IPNet, usage string, validation ...func(value net.IPNet) error)
IPNetVar defines an net.IPNet flag with specified name, default value, and usage string. The argument p points to an net.IPNet variable in which to store the value of the flag.
func (*FlagSet) IPNetVarP ¶
func (f *FlagSet) IPNetVarP(p *net.IPNet, name, shorthand string, value net.IPNet, usage string, validation ...func(value net.IPNet) error)
IPNetVarP is like IPNetVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IPP ¶
func (f *FlagSet) IPP(name, shorthand string, value net.IP, usage string, validation ...func(value net.IP) error) *net.IP
IPP is like IP, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IPSlice ¶
func (f *FlagSet) IPSlice(name string, value []net.IP, usage string, validation ...func(value []net.IP) error) *[]net.IP
IPSlice defines a []net.IP flag with specified name, default value, and usage string. The return value is the address of a []net.IP variable that stores the value of that flag.
func (*FlagSet) IPSliceP ¶
func (f *FlagSet) IPSliceP(name, shorthand string, value []net.IP, usage string, validation ...func(value []net.IP) error) *[]net.IP
IPSliceP is like IPSlice, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IPSliceVar ¶
func (f *FlagSet) IPSliceVar(p *[]net.IP, name string, value []net.IP, usage string, validation ...func(value []net.IP) error)
IPSliceVar defines a ipSlice flag with specified name, default value, and usage string. The argument p points to a []net.IP variable in which to store the value of the flag.
func (*FlagSet) IPSliceVarP ¶
func (f *FlagSet) IPSliceVarP(p *[]net.IP, name, shorthand string, value []net.IP, usage string, validation ...func(value []net.IP) error)
IPSliceVarP is like IPSliceVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IPVar ¶
func (f *FlagSet) IPVar(p *net.IP, name string, value net.IP, usage string, validation ...func(value net.IP) error)
IPVar defines an net.IP flag with specified name, default value, and usage string. The argument p points to an net.IP variable in which to store the value of the flag.
func (*FlagSet) IPVarP ¶
func (f *FlagSet) IPVarP(p *net.IP, name, shorthand string, value net.IP, usage string, validation ...func(value net.IP) error)
IPVarP is like IPVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Init ¶
func (f *FlagSet) Init(name string, errorHandling ErrorHandling)
Init sets the name and error handling property for a flag set. By default, the zero FlagSet uses an empty name and the ContinueOnError error handling policy.
func (*FlagSet) Int ¶
func (f *FlagSet) Int(name string, value int, usage string, validation ...func(value int) error) *int
Int defines an int flag with specified name, default value, and usage string. The return value is the address of an int variable that stores the value of the flag.
func (*FlagSet) Int16 ¶
func (f *FlagSet) Int16(name string, value int16, usage string, validation ...func(value int16) error) *int16
Int16 defines an int16 flag with specified name, default value, and usage string. The return value is the address of an int16 variable that stores the value of the flag.
func (*FlagSet) Int16P ¶
func (f *FlagSet) Int16P(name, shorthand string, value int16, usage string, validation ...func(value int16) error) *int16
Int16P is like Int16, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Int16Var ¶
func (f *FlagSet) Int16Var(p *int16, name string, value int16, usage string, validation ...func(value int16) error)
Int16Var defines an int16 flag with specified name, default value, and usage string. The argument p points to an int16 variable in which to store the value of the flag.
func (*FlagSet) Int16VarP ¶
func (f *FlagSet) Int16VarP(p *int16, name, shorthand string, value int16, usage string, validation ...func(value int16) error)
Int16VarP is like Int16Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Int32 ¶
func (f *FlagSet) Int32(name string, value int32, usage string, validation ...func(value int32) error) *int32
Int32 defines an int32 flag with specified name, default value, and usage string. The return value is the address of an int32 variable that stores the value of the flag.
func (*FlagSet) Int32P ¶
func (f *FlagSet) Int32P(name, shorthand string, value int32, usage string, validation ...func(value int32) error) *int32
Int32P is like Int32, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Int32Slice ¶
func (f *FlagSet) Int32Slice(name string, value []int32, usage string, validation ...func(value []int32) error) *[]int32
Int32Slice defines a []int32 flag with specified name, default value, and usage string. The return value is the address of a []int32 variable that stores the value of the flag.
func (*FlagSet) Int32SliceP ¶
func (f *FlagSet) Int32SliceP(name, shorthand string, value []int32, usage string, validation ...func(value []int32) error) *[]int32
Int32SliceP is like Int32Slice, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Int32SliceVar ¶
func (f *FlagSet) Int32SliceVar(p *[]int32, name string, value []int32, usage string, validation ...func(value []int32) error)
Int32SliceVar defines a int32Slice flag with specified name, default value, and usage string. The argument p points to a []int32 variable in which to store the value of the flag.
func (*FlagSet) Int32SliceVarP ¶
func (f *FlagSet) Int32SliceVarP(p *[]int32, name, shorthand string, value []int32, usage string, validation ...func(value []int32) error)
Int32SliceVarP is like Int32SliceVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Int32Var ¶
func (f *FlagSet) Int32Var(p *int32, name string, value int32, usage string, validation ...func(value int32) error)
Int32Var defines an int32 flag with specified name, default value, and usage string. The argument p points to an int32 variable in which to store the value of the flag.
func (*FlagSet) Int32VarP ¶
func (f *FlagSet) Int32VarP(p *int32, name, shorthand string, value int32, usage string, validation ...func(value int32) error)
Int32VarP is like Int32Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Int64 ¶
func (f *FlagSet) Int64(name string, value int64, usage string, validation ...func(value int64) error) *int64
Int64 defines an int64 flag with specified name, default value, and usage string. The return value is the address of an int64 variable that stores the value of the flag.
func (*FlagSet) Int64P ¶
func (f *FlagSet) Int64P(name, shorthand string, value int64, usage string, validation ...func(value int64) error) *int64
Int64P is like Int64, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Int64Slice ¶
func (f *FlagSet) Int64Slice(name string, value []int64, usage string, validation ...func(value []int64) error) *[]int64
Int64Slice defines a []int64 flag with specified name, default value, and usage string. The return value is the address of a []int64 variable that stores the value of the flag.
func (*FlagSet) Int64SliceP ¶
func (f *FlagSet) Int64SliceP(name, shorthand string, value []int64, usage string, validation ...func(value []int64) error) *[]int64
Int64SliceP is like Int64Slice, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Int64SliceVar ¶
func (f *FlagSet) Int64SliceVar(p *[]int64, name string, value []int64, usage string, validation ...func(value []int64) error)
Int64SliceVar defines a int64Slice flag with specified name, default value, and usage string. The argument p points to a []int64 variable in which to store the value of the flag.
func (*FlagSet) Int64SliceVarP ¶
func (f *FlagSet) Int64SliceVarP(p *[]int64, name, shorthand string, value []int64, usage string, validation ...func(value []int64) error)
Int64SliceVarP is like Int64SliceVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Int64Var ¶
func (f *FlagSet) Int64Var(p *int64, name string, value int64, usage string, validation ...func(value int64) error)
Int64Var defines an int64 flag with specified name, default value, and usage string. The argument p points to an int64 variable in which to store the value of the flag.
func (*FlagSet) Int64VarP ¶
func (f *FlagSet) Int64VarP(p *int64, name, shorthand string, value int64, usage string, validation ...func(value int64) error)
Int64VarP is like Int64Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Int8 ¶
func (f *FlagSet) Int8(name string, value int8, usage string, validation ...func(value int8) error) *int8
Int8 defines an int8 flag with specified name, default value, and usage string. The return value is the address of an int8 variable that stores the value of the flag.
func (*FlagSet) Int8P ¶
func (f *FlagSet) Int8P(name, shorthand string, value int8, usage string, validation ...func(value int8) error) *int8
Int8P is like Int8, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Int8Var ¶
func (f *FlagSet) Int8Var(p *int8, name string, value int8, usage string, validation ...func(value int8) error)
Int8Var defines an int8 flag with specified name, default value, and usage string. The argument p points to an int8 variable in which to store the value of the flag.
func (*FlagSet) Int8VarP ¶
func (f *FlagSet) Int8VarP(p *int8, name, shorthand string, value int8, usage string, validation ...func(value int8) error)
Int8VarP is like Int8Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IntP ¶
func (f *FlagSet) IntP(name, shorthand string, value int, usage string, validation ...func(value int) error) *int
IntP is like Int, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IntSlice ¶
func (f *FlagSet) IntSlice(name string, value []int, usage string, validation ...func(value []int) error) *[]int
IntSlice defines a []int flag with specified name, default value, and usage string. The return value is the address of a []int variable that stores the value of the flag.
func (*FlagSet) IntSliceP ¶
func (f *FlagSet) IntSliceP(name, shorthand string, value []int, usage string, validation ...func(value []int) error) *[]int
IntSliceP is like IntSlice, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IntSliceVar ¶
func (f *FlagSet) IntSliceVar(p *[]int, name string, value []int, usage string, validation ...func(value []int) error)
IntSliceVar defines a intSlice flag with specified name, default value, and usage string. The argument p points to a []int variable in which to store the value of the flag.
func (*FlagSet) IntSliceVarP ¶
func (f *FlagSet) IntSliceVarP(p *[]int, name, shorthand string, value []int, usage string, validation ...func(value []int) error)
IntSliceVarP is like IntSliceVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) IntVar ¶
func (f *FlagSet) IntVar(p *int, name string, value int, usage string, validation ...func(value int) error)
IntVar defines an int flag with specified name, default value, and usage string. The argument p points to an int variable in which to store the value of the flag.
func (*FlagSet) IntVarP ¶
func (f *FlagSet) IntVarP(p *int, name, shorthand string, value int, usage string, validation ...func(value int) error)
IntVarP is like IntVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Lookup ¶
Lookup returns the Flag structure of the named flag, returning nil if none exists.
func (*FlagSet) MarkDeprecated ¶
MarkDeprecated indicated that a flag is deprecated in your program. It will continue to function but will not show up in help or usage messages. Using this flag will also print the given usageMessage.
func (*FlagSet) MarkHidden ¶
MarkHidden sets a flag to 'hidden' in your program. It will continue to function but will not show up in help or usage messages.
func (*FlagSet) MarkShorthandDeprecated ¶
MarkShorthandDeprecated will mark the shorthand of a flag deprecated in your program. It will continue to function but will not show up in help or usage messages. Using this flag will also print the given usageMessage.
func (*FlagSet) Output ¶
Output returns the destination for usage and error messages. os.Stderr is returned if output was not set or was set to nil.
func (*FlagSet) Parse ¶
Parse parses flag definitions from the argument list, which should not include the command name. Must be called after all flags in the FlagSet are defined and before flags are accessed by the program. The return value will be ErrHelp if -help was set but not defined.
func (*FlagSet) ParseAll ¶
ParseAll parses flag definitions from the argument list, which should not include the command name. The arguments for fn are flag and value. Must be called after all flags in the FlagSet are defined and before flags are accessed by the program. The return value will be ErrHelp if -help was set but not defined.
func (*FlagSet) PrintDefaults ¶
func (f *FlagSet) PrintDefaults()
PrintDefaults prints, to standard error unless configured otherwise, the default values of all defined flags in the set.
func (*FlagSet) SetAnnotation ¶
SetAnnotation allows one to set arbitrary annotations on a flag in the FlagSet. This is sometimes used by spf13/cobra programs which want to generate additional bash completion information.
func (*FlagSet) SetInterspersed ¶
SetInterspersed sets whether to support interspersed option/non-option arguments.
func (*FlagSet) SetNormalizeFunc ¶
func (f *FlagSet) SetNormalizeFunc(n func(f *FlagSet, name string) NormalizedName)
SetNormalizeFunc allows you to add a function which can translate flag names. Flags added to the FlagSet will be translated and then when anything tries to look up the flag that will also be translated. So it would be possible to create a flag named "getURL" and have it translated to "geturl". A user could then pass "--getUrl" which may also be translated to "geturl" and everything will work.
func (*FlagSet) SetOutput ¶
SetOutput sets the destination for usage and error messages. If output is nil, os.Stderr is used.
func (*FlagSet) ShorthandLookup ¶
ShorthandLookup returns the Flag structure of the short handed flag, returning nil if none exists. It panics, if len(name) > 1.
Example ¶
package main import ( "fmt" "github.com/erfanmomeniii/pflag" ) func main() { name := "verbose" short := name[:1] fs := pflag.NewFlagSet("Example", pflag.ContinueOnError) fs.BoolP(name, short, false, "verbose output") // len(short) must be == 1 flag := fs.ShorthandLookup(short) fmt.Println(flag.Name) }
Output:
func (*FlagSet) String ¶
func (f *FlagSet) String(name string, value string, usage string, validation ...func(value string) error) *string
String defines a string flag with specified name, default value, and usage string. The return value is the address of a string variable that stores the value of the flag.
func (*FlagSet) StringArray ¶
func (f *FlagSet) StringArray(name string, value []string, usage string, validation ...func(value []string) error) *[]string
StringArray defines a string flag with specified name, default value, and usage string. The return value is the address of a []string variable that stores the value of the flag. The value of each argument will not try to be separated by comma. Use a StringSlice for that.
func (*FlagSet) StringArrayP ¶
func (f *FlagSet) StringArrayP(name, shorthand string, value []string, usage string, validation ...func(value []string) error) *[]string
StringArrayP is like StringArray, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) StringArrayVar ¶
func (f *FlagSet) StringArrayVar(p *[]string, name string, value []string, usage string, validation ...func(value []string) error)
StringArrayVar defines a string flag with specified name, default value, and usage string. The argument p points to a []string variable in which to store the values of the multiple flags. The value of each argument will not try to be separated by comma. Use a StringSlice for that.
func (*FlagSet) StringArrayVarP ¶
func (f *FlagSet) StringArrayVarP(p *[]string, name, shorthand string, value []string, usage string, validation ...func(value []string) error)
StringArrayVarP is like StringArrayVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) StringP ¶
func (f *FlagSet) StringP(name, shorthand string, value string, usage string, validation ...func(value string) error) *string
StringP is like String, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) StringSlice ¶
func (f *FlagSet) StringSlice(name string, value []string, usage string, validation ...func(value []string) error) *[]string
StringSlice defines a string flag with specified name, default value, and usage string. The return value is the address of a []string variable that stores the value of the flag. Compared to StringArray flags, StringSlice flags take comma-separated value as arguments and split them accordingly. For example:
--ss="v1,v2" --ss="v3"
will result in
[]string{"v1", "v2", "v3"}
func (*FlagSet) StringSliceP ¶
func (f *FlagSet) StringSliceP(name, shorthand string, value []string, usage string, validation ...func(value []string) error) *[]string
StringSliceP is like StringSlice, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) StringSliceVar ¶
func (f *FlagSet) StringSliceVar(p *[]string, name string, value []string, usage string, validation ...func(value []string) error)
StringSliceVar defines a string flag with specified name, default value, and usage string. The argument p points to a []string variable in which to store the value of the flag. Compared to StringArray flags, StringSlice flags take comma-separated value as arguments and split them accordingly. For example:
--ss="v1,v2" --ss="v3"
will result in
[]string{"v1", "v2", "v3"}
func (*FlagSet) StringSliceVarP ¶
func (f *FlagSet) StringSliceVarP(p *[]string, name, shorthand string, value []string, usage string, validation ...func(value []string) error)
StringSliceVarP is like StringSliceVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) StringToInt ¶
func (f *FlagSet) StringToInt(name string, value map[string]int, usage string, validation ...func(value map[string]int) error) *map[string]int
StringToInt defines a string flag with specified name, default value, and usage string. The return value is the address of a map[string]int variable that stores the value of the flag. The value of each argument will not try to be separated by comma
func (*FlagSet) StringToInt64 ¶
func (f *FlagSet) StringToInt64(name string, value map[string]int64, usage string, validation ...func(value map[string]int64) error) *map[string]int64
StringToInt64 defines a string flag with specified name, default value, and usage string. The return value is the address of a map[string]int64 variable that stores the value of the flag. The value of each argument will not try to be separated by comma
func (*FlagSet) StringToInt64P ¶
func (f *FlagSet) StringToInt64P(name, shorthand string, value map[string]int64, usage string, validation ...func(value map[string]int64) error) *map[string]int64
StringToInt64P is like StringToInt64, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) StringToInt64Var ¶
func (f *FlagSet) StringToInt64Var(p *map[string]int64, name string, value map[string]int64, usage string, validation ...func(value map[string]int64) error)
StringToInt64Var defines a string flag with specified name, default value, and usage string. The argument p point64s to a map[string]int64 variable in which to store the values of the multiple flags. The value of each argument will not try to be separated by comma
func (*FlagSet) StringToInt64VarP ¶
func (f *FlagSet) StringToInt64VarP(p *map[string]int64, name, shorthand string, value map[string]int64, usage string, validation ...func(value map[string]int64) error)
StringToInt64VarP is like StringToInt64Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) StringToIntP ¶
func (f *FlagSet) StringToIntP(name, shorthand string, value map[string]int, usage string, validation ...func(value map[string]int) error) *map[string]int
StringToIntP is like StringToInt, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) StringToIntVar ¶
func (f *FlagSet) StringToIntVar(p *map[string]int, name string, value map[string]int, usage string, validation ...func(value map[string]int) error)
StringToIntVar defines a string flag with specified name, default value, and usage string. The argument p points to a map[string]int variable in which to store the values of the multiple flags. The value of each argument will not try to be separated by comma
func (*FlagSet) StringToIntVarP ¶
func (f *FlagSet) StringToIntVarP(p *map[string]int, name, shorthand string, value map[string]int, usage string, validation ...func(value map[string]int) error)
StringToIntVarP is like StringToIntVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) StringToString ¶
func (f *FlagSet) StringToString(name string, value map[string]string, usage string, validation ...func(value map[string]string) error) *map[string]string
StringToString defines a string flag with specified name, default value, and usage string. The return value is the address of a map[string]string variable that stores the value of the flag. The value of each argument will not try to be separated by comma
func (*FlagSet) StringToStringP ¶
func (f *FlagSet) StringToStringP(name, shorthand string, value map[string]string, usage string, validation ...func(value map[string]string) error) *map[string]string
StringToStringP is like StringToString, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) StringToStringVar ¶
func (f *FlagSet) StringToStringVar(p *map[string]string, name string, value map[string]string, usage string, validation ...func(value map[string]string) error)
StringToStringVar defines a string flag with specified name, default value, and usage string. The argument p points to a map[string]string variable in which to store the values of the multiple flags. The value of each argument will not try to be separated by comma
func (*FlagSet) StringToStringVarP ¶
func (f *FlagSet) StringToStringVarP(p *map[string]string, name, shorthand string, value map[string]string, usage string, validation ...func(value map[string]string) error)
StringToStringVarP is like StringToStringVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) StringVar ¶
func (f *FlagSet) StringVar(p *string, name string, value string, usage string, validation ...func(value string) error)
StringVar defines a string flag with specified name, default value, and usage string. The argument p points to a string variable in which to store the value of the flag.
func (*FlagSet) StringVarP ¶
func (f *FlagSet) StringVarP(p *string, name, shorthand string, value string, usage string, validation ...func(value string) error)
StringVarP is like StringVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Uint ¶
func (f *FlagSet) Uint(name string, value uint, usage string, validation ...func(value uint) error) *uint
Uint defines a uint flag with specified name, default value, and usage string. The return value is the address of a uint variable that stores the value of the flag.
func (*FlagSet) Uint16 ¶
func (f *FlagSet) Uint16(name string, value uint16, usage string, validation ...func(value uint16) error) *uint16
Uint16 defines a uint flag with specified name, default value, and usage string. The return value is the address of a uint variable that stores the value of the flag.
func (*FlagSet) Uint16P ¶
func (f *FlagSet) Uint16P(name, shorthand string, value uint16, usage string, validation ...func(value uint16) error) *uint16
Uint16P is like Uint16, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Uint16Var ¶
func (f *FlagSet) Uint16Var(p *uint16, name string, value uint16, usage string, validation ...func(value uint16) error)
Uint16Var defines a uint flag with specified name, default value, and usage string. The argument p points to a uint variable in which to store the value of the flag.
func (*FlagSet) Uint16VarP ¶
func (f *FlagSet) Uint16VarP(p *uint16, name, shorthand string, value uint16, usage string, validation ...func(value uint16) error)
Uint16VarP is like Uint16Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Uint32 ¶
func (f *FlagSet) Uint32(name string, value uint32, usage string, validation ...func(value uint32) error) *uint32
Uint32 defines a uint32 flag with specified name, default value, and usage string. The return value is the address of a uint32 variable that stores the value of the flag.
func (*FlagSet) Uint32P ¶
func (f *FlagSet) Uint32P(name, shorthand string, value uint32, usage string, validation ...func(value uint32) error) *uint32
Uint32P is like Uint32, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Uint32Var ¶
func (f *FlagSet) Uint32Var(p *uint32, name string, value uint32, usage string, validation ...func(value uint32) error)
Uint32Var defines a uint32 flag with specified name, default value, and usage string. The argument p points to a uint32 variable in which to store the value of the flag.
func (*FlagSet) Uint32VarP ¶
func (f *FlagSet) Uint32VarP(p *uint32, name, shorthand string, value uint32, usage string, validation ...func(value uint32) error)
Uint32VarP is like Uint32Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Uint64 ¶
func (f *FlagSet) Uint64(name string, value uint64, usage string, validation ...func(value uint64) error) *uint64
Uint64 defines a uint64 flag with specified name, default value, and usage string. The return value is the address of a uint64 variable that stores the value of the flag.
func (*FlagSet) Uint64P ¶
func (f *FlagSet) Uint64P(name, shorthand string, value uint64, usage string, validation ...func(value uint64) error) *uint64
Uint64P is like Uint64, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Uint64Var ¶
func (f *FlagSet) Uint64Var(p *uint64, name string, value uint64, usage string, validation ...func(value uint64) error)
Uint64Var defines a uint64 flag with specified name, default value, and usage string. The argument p points to a uint64 variable in which to store the value of the flag.
func (*FlagSet) Uint64VarP ¶
func (f *FlagSet) Uint64VarP(p *uint64, name, shorthand string, value uint64, usage string, validation ...func(value uint64) error)
Uint64VarP is like Uint64Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Uint8 ¶
func (f *FlagSet) Uint8(name string, value uint8, usage string, validation ...func(value uint8) error) *uint8
Uint8 defines a uint8 flag with specified name, default value, and usage string. The return value is the address of a uint8 variable that stores the value of the flag.
func (*FlagSet) Uint8P ¶
func (f *FlagSet) Uint8P(name, shorthand string, value uint8, usage string, validation ...func(value uint8) error) *uint8
Uint8P is like Uint8, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Uint8Var ¶
func (f *FlagSet) Uint8Var(p *uint8, name string, value uint8, usage string, validation ...func(value uint8) error)
Uint8Var defines a uint8 flag with specified name, default value, and usage string. The argument p points to a uint8 variable in which to store the value of the flag.
func (*FlagSet) Uint8VarP ¶
func (f *FlagSet) Uint8VarP(p *uint8, name, shorthand string, value uint8, usage string, validation ...func(value uint8) error)
Uint8VarP is like Uint8Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) UintP ¶
func (f *FlagSet) UintP(name, shorthand string, value uint, usage string, validation ...func(value uint) error) *uint
UintP is like Uint, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) UintSlice ¶
func (f *FlagSet) UintSlice(name string, value []uint, usage string, validation ...func(value []uint) error) *[]uint
UintSlice defines a []uint flag with specified name, default value, and usage string. The return value is the address of a []uint variable that stores the value of the flag.
func (*FlagSet) UintSliceP ¶
func (f *FlagSet) UintSliceP(name, shorthand string, value []uint, usage string, validation ...func(value []uint) error) *[]uint
UintSliceP is like UintSlice, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) UintSliceVar ¶
func (f *FlagSet) UintSliceVar(p *[]uint, name string, value []uint, usage string, validation ...func(value []uint) error)
UintSliceVar defines a uintSlice flag with specified name, default value, and usage string. The argument p points to a []uint variable in which to store the value of the flag.
func (*FlagSet) UintSliceVarP ¶
func (f *FlagSet) UintSliceVarP(p *[]uint, name, shorthand string, value []uint, usage string, validation ...func(value []uint) error)
UintSliceVarP is like UintSliceVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) UintVar ¶
func (f *FlagSet) UintVar(p *uint, name string, value uint, usage string, validation ...func(value uint) error)
UintVar defines a uint flag with specified name, default value, and usage string. The argument p points to a uint variable in which to store the value of the flag.
func (*FlagSet) UintVarP ¶
func (f *FlagSet) UintVarP(p *uint, name, shorthand string, value uint, usage string, validation ...func(value uint) error)
UintVarP is like UintVar, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) Var ¶
Var defines a flag with the specified name and usage string. The type and value of the flag are represented by the first argument, of type Value, which typically holds a user-defined implementation of Value. For instance, the caller could create a flag that turns a comma-separated string into a slice of strings by giving the slice the methods of Value; in particular, Set would decompose the comma-separated string into the slice.
func (*FlagSet) VarP ¶
VarP is like Var, but accepts a shorthand letter that can be used after a single dash.
func (*FlagSet) VarPF ¶
func (f *FlagSet) VarPF(value Value, name, shorthand, usage string, validation ...interface{}) *Flag
VarPF is like VarP, but returns the flag created
type NormalizedName ¶
type NormalizedName string
NormalizedName is a flag name that has been normalized according to rules for the FlagSet (e.g. making '-' and '_' equivalent).
type ParseErrorsWhitelist ¶
type ParseErrorsWhitelist struct { // UnknownFlags will ignore unknown flags errors and continue parsing rest of the flags UnknownFlags bool }
ParseErrorsWhitelist defines the parsing errors that can be ignored
type SliceValue ¶
type SliceValue interface { // Append adds the specified value to the end of the flag value list. Append(string) error // Replace will fully overwrite any data currently in the flag value list. Replace([]string) error // GetSlice returns the flag value list as an array of strings. GetSlice() []string }
SliceValue is a secondary interface to all flags which hold a list of values. This allows full control over the value of list flags, and avoids complicated marshalling and unmarshalling to csv.
Source Files
¶
- bool.go
- bool_slice.go
- bytes.go
- count.go
- duration.go
- duration_slice.go
- flag.go
- float32.go
- float32_slice.go
- float64.go
- float64_slice.go
- golangflag.go
- int.go
- int16.go
- int32.go
- int32_slice.go
- int64.go
- int64_slice.go
- int8.go
- int_slice.go
- ip.go
- ip_slice.go
- ipmask.go
- ipnet.go
- ipnet_slice.go
- string.go
- string_array.go
- string_slice.go
- string_to_int.go
- string_to_int64.go
- string_to_string.go
- uint.go
- uint16.go
- uint32.go
- uint64.go
- uint8.go
- uint_slice.go