Documentation
¶
Overview ¶
Package cmdflag handles flag processing common to several go tools.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrFlagTerminator = errors.New("flag terminator")
ErrFlagTerminator indicates the distinguished token "--", which causes the flag package to treat all subsequent arguments as non-flags.
Functions ¶
func ParseOne ¶ added in go1.15
ParseOne sees if args[0] is present in the given flag set and if so, sets its value and returns the flag along with the remaining (unused) arguments.
ParseOne always returns either a non-nil Flag or a non-nil error, and always consumes at least one argument (even on error).
Unlike (*flag.FlagSet).Parse, ParseOne does not log its own errors.
Types ¶
type FlagNotDefinedError ¶ added in go1.15
type FlagNotDefinedError struct {
RawArg string // the original argument, like --foo or -foo=value
Name string
HasValue bool // is this the -foo=value or --foo=value form?
Value string // only provided if HasValue is true
}
A FlagNotDefinedError indicates a flag-like argument that does not correspond to any registered flag in a FlagSet.
func (FlagNotDefinedError) Error ¶ added in go1.15
func (e FlagNotDefinedError) Error() string
type NonFlagError ¶ added in go1.15
type NonFlagError struct {
RawArg string
}
A NonFlagError indicates an argument that is not a syntactically-valid flag.
func (NonFlagError) Error ¶ added in go1.15
func (e NonFlagError) Error() string
Source Files