flags

Documentation

Index

• func ConsumeUnparsedValue(longForm string, shortForm byte, isBool bool, args []string) (string, bool, []string, error)
• func DeprecationIfChanged(cmd *cobra.Command, flagName, alternative string)
• func GetUnparsedBoolean(args []string, flag string) (bool, bool, error)
• func GetUnparsedValue(longForm string, shortForm byte, isBool bool, args []string) (string, bool, error)
• func HasOption(longForm string, shortForm byte, args []string) bool
• func Map(flags *pflag.FlagSet) map[string]string

Functions

func ConsumeUnparsedValue

func ConsumeUnparsedValue(longForm string, shortForm byte, isBool bool, args []string) (string, bool, []string, error)

ConsumeUnparsedValue parses the given args for a matching option. If found, the option and value is removed from args. The string value of the option, a boolean indicating if the option was found, the possibly modified args array is returned. The function may also return an error for a malformed option. Typically a non-bool option that lacks a value.

func DeprecationIfChanged

func DeprecationIfChanged(cmd *cobra.Command, flagName, alternative string)

DeprecationIfChanged will print a deprecation warning on output.Info if the flag has changed.

Use this method instead of the standard pflag deprecation to ensure that the deprecation message doesn't clobber JSON output.

func GetUnparsedBoolean

func GetUnparsedBoolean(args []string, flag string) (bool, bool, error)

GetUnparsedBoolean returns the value of a boolean flag that has been provided after a "--" on the command line, and hence hasn't been parsed as a normal flag. Typical use case is:

telepresence intercept --docker-run ... -- --rm

func GetUnparsedValue

func GetUnparsedValue(longForm string, shortForm byte, isBool bool, args []string) (string, bool, error)

GetUnparsedValue parses the given args for a matching option. The string value of the option and a boolean indicating if the option was found. The function may also return an error for a malformed option. Typically a non-bool option that lacks a value.

func HasOption

func HasOption(longForm string, shortForm byte, args []string) bool

func Map

func Map(flags *pflag.FlagSet) map[string]string

Map returns a map of the flags that has been modified in the given FlagSet.