argument

Documentation

Index

• Constants
• type InputArgument
  • func New(name string, mode int) *InputArgument
  • func (a *InputArgument) Default() string
  • func (a *InputArgument) Defaults() []string
  • func (a *InputArgument) Description() string
  • func (a *InputArgument) IsList() bool
  • func (a *InputArgument) IsRequired() bool
  • func (a *InputArgument) Name() string
  • func (a *InputArgument) SetDefault(defaultValue string) *InputArgument
  • func (a *InputArgument) SetDefaults(values []string) *InputArgument
  • func (a *InputArgument) SetDescription(desc string) *InputArgument

Constants

const (
	Default  = Optional
	Required = 1
	Optional = 2
	List     = 4
)

Types

type InputArgument

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

Represents a command line argument.

func New

func New(
	name string,
	mode int,
) *InputArgument

constructor

func (*InputArgument) Default

func (a *InputArgument) Default() string

Returns the default value.

func (*InputArgument) Defaults

func (a *InputArgument) Defaults() []string

Returns the defaults value.

func (*InputArgument) Description

func (a *InputArgument) Description() string

Returns the description text

func (*InputArgument) IsList

func (a *InputArgument) IsList() bool

Returns true if the argument can take multiple values.

func (*InputArgument) IsRequired

func (a *InputArgument) IsRequired() bool

Returns true if the argument is required.

func (*InputArgument) Name

func (a *InputArgument) Name() string

Returns the argument name.

func (*InputArgument) SetDefault

func (a *InputArgument) SetDefault(defaultValue string) *InputArgument

Sets the default value.

func (*InputArgument) SetDefaults

func (a *InputArgument) SetDefaults(values []string) *InputArgument

Sets the default value for array args.

func (*InputArgument) SetDescription

func (a *InputArgument) SetDescription(desc string) *InputArgument

Returns the description text