descriptor

Documentation

Index

• type Descriptor
  • func (arg *Descriptor) Add(pos *counters.Conditional, short string, long string, argType types.ArgTypes, ...) (err error)
  • func (arg *Descriptor) GetDefault() string
  • func (arg *Descriptor) GetHelp() string
  • func (arg *Descriptor) GetLong() string
  • func (arg *Descriptor) GetPosition() int
  • func (arg *Descriptor) GetShort() string
  • func (arg *Descriptor) GetType() types.ArgTypes

Types

type Descriptor

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

Descriptor - A Descriptor struct

func (*Descriptor) Add

func (arg *Descriptor) Add(pos *counters.Conditional, short string, long string,
	argType types.ArgTypes, required bool, argDefault any, help string) (err error)

Add - Sanitize and set the descriptor _config.

func (*Descriptor) GetDefault

func (arg *Descriptor) GetDefault() string

GetDefault - Return current default

func (*Descriptor) GetHelp

func (arg *Descriptor) GetHelp() string

GetHelp - return help string

func (*Descriptor) GetLong

func (arg *Descriptor) GetLong() string

GetLong - Search the long arguments and return boolean true if found along with reference to the descriptor

func (*Descriptor) GetPosition

func (arg *Descriptor) GetPosition() int

GetPosition - Return the position value for the current descriptor

func (*Descriptor) GetShort

func (arg *Descriptor) GetShort() string

GetShort - Search the short arguments and return boolean true if found along with reference to the descriptor

func (*Descriptor) GetType

func (arg *Descriptor) GetType() types.ArgTypes

GetType - Return current type