flagutil

Documentation

Index

• type EnumFlag
  • func NewEnumFlag(flagDescription string, allowedValues []string, defaultValue string) *EnumFlag
  • func (e *EnumFlag) Set(input string) error
  • func (e *EnumFlag) String() string
  • func (e *EnumFlag) Type() string
  • func (e *EnumFlag) Usage() string

Types

type EnumFlag

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

EnumFlag allows setting a list of values.

func NewEnumFlag

func NewEnumFlag(flagDescription string, allowedValues []string, defaultValue string) *EnumFlag

NewEnumFlag creates and returns an enum flag value with the given description, allowedValues and defaultValue.

func (*EnumFlag) Set

func (e *EnumFlag) Set(input string) error

Set implements pflag.Value.

func (*EnumFlag) String

func (e *EnumFlag) String() string

String implements pflag.Value. It is the preferred method of retrieving the set value for the enum.

func (*EnumFlag) Type

func (e *EnumFlag) Type() string

Type implements pflag.Value.

func (*EnumFlag) Usage

func (e *EnumFlag) Usage() string

Usage returns a string that can be used as help text for this flag. It will include the flag type and the list of allowed values.