flag

Documentation

Index

• func NewBuilder(provider A.Provider) A.FlagBuilder
• func NewFlagGroupBuilder(A.Provider) A.FlagGroupBuilder
• type Builder
  • func (f *Builder) Arg(arg argo.ArgumentBuilder) argo.FlagBuilder
  • func (f *Builder) Bind(ptr interface{}, required bool) argo.FlagBuilder
  • func (f *Builder) BindUseCount(ptr *int) argo.FlagBuilder
  • func (f *Builder) Build() (out A.Flag, err error)
  • func (f *Builder) Default(val interface{}) argo.FlagBuilder
  • func (f *Builder) Description(desc string) argo.FlagBuilder
  • func (f *Builder) GetArg() argo.ArgumentBuilder
  • func (f *Builder) GetDescription() string
  • func (f *Builder) GetLong() string
  • func (f *Builder) GetShort() byte
  • func (f *Builder) HasArg() bool
  • func (f *Builder) HasDescription() bool
  • func (f *Builder) HasLong() bool
  • func (f *Builder) HasShort() bool
  • func (f *Builder) Long(flag string) argo.FlagBuilder
  • func (f *Builder) MustBuild() A.Flag
  • func (f *Builder) OnHit(fn argo.FlagEventHandler) argo.FlagBuilder
  • func (f *Builder) Parent(fg argo.FlagGroup) argo.FlagBuilder
  • func (f *Builder) Short(flag byte) argo.FlagBuilder
• type Flag
  • func (f *Flag) Argument() A.Argument
  • func (f *Flag) HasArgument() bool
  • func (f *Flag) HasLong() bool
  • func (f *Flag) HasShort() bool
  • func (f *Flag) Hits() int
  • func (f *Flag) IncrementHits()
  • func (f *Flag) Long() string
  • func (f *Flag) Parent() A.FlagGroup
  • func (f *Flag) Required() bool
  • func (f *Flag) Short() byte
  • func (f *Flag) String() (out string)
• type GBuilder
  • func (f *GBuilder) Build() (out A.FlagGroup, err error)
  • func (f *GBuilder) Description(desc string) A.FlagGroupBuilder
  • func (f *GBuilder) Flag(flag A.FlagBuilder) A.FlagGroupBuilder
  • func (f *GBuilder) GetDescription() string
  • func (f *GBuilder) GetFlags() []A.FlagBuilder
  • func (f *GBuilder) GetName() string
  • func (f *GBuilder) MustBuild() A.FlagGroup
  • func (f *GBuilder) Name(name string) A.FlagGroupBuilder
  • func (f *GBuilder) Parent(com A.Command) A.FlagGroupBuilder
• type Group
  • func (f *Group) Flags() []A.Flag
  • func (f *Group) HasFlags() bool
  • func (f *Group) Parent() A.Command

Functions

func NewBuilder

func NewBuilder(provider A.Provider) A.FlagBuilder

func NewFlagGroupBuilder

func NewFlagGroupBuilder(A.Provider) A.FlagGroupBuilder

Types

type Builder

type Builder struct {
	Provider A.Provider

	Error error

	ShortFlag  byte
	IsShortSet bool

	LongFlag  string
	IsLongSet bool

	DescriptionText trait.Described

	ArgBuilder A.ArgumentBuilder

	UseCountBinding *int
	OnHitCallback   A.FlagEventHandler

	ParentElement A.FlagGroup
}

func (*Builder) Arg

func (f *Builder) Arg(arg argo.ArgumentBuilder) argo.FlagBuilder

func (*Builder) Bind

func (f *Builder) Bind(ptr interface{}, required bool) argo.FlagBuilder

func (*Builder) BindUseCount

func (f *Builder) BindUseCount(ptr *int) argo.FlagBuilder

func (*Builder) Build

func (f *Builder) Build() (out A.Flag, err error)

func (*Builder) Default

func (f *Builder) Default(val interface{}) argo.FlagBuilder

func (*Builder) Description

func (f *Builder) Description(desc string) argo.FlagBuilder

func (*Builder) GetArg

func (f *Builder) GetArg() argo.ArgumentBuilder

func (*Builder) GetDescription

func (f *Builder) GetDescription() string

func (*Builder) GetLong

func (f *Builder) GetLong() string

func (*Builder) GetShort

func (f *Builder) GetShort() byte

func (*Builder) HasArg

func (f *Builder) HasArg() bool

func (*Builder) HasDescription

func (f *Builder) HasDescription() bool

func (*Builder) HasLong

func (f *Builder) HasLong() bool

func (*Builder) HasShort

func (f *Builder) HasShort() bool

func (*Builder) Long

func (f *Builder) Long(flag string) argo.FlagBuilder

func (*Builder) MustBuild

func (f *Builder) MustBuild() A.Flag

func (*Builder) OnHit

func (f *Builder) OnHit(fn argo.FlagEventHandler) argo.FlagBuilder

func (*Builder) Parent

func (f *Builder) Parent(fg argo.FlagGroup) argo.FlagBuilder

func (*Builder) Short

func (f *Builder) Short(flag byte) argo.FlagBuilder

type Flag

type Flag struct {
	trait.Described

	ParentElement   A.FlagGroup
	ArgumentElement A.Argument

	HitCount   uint
	LongForm   string
	ShortForm  byte
	IsRequired bool

	HitCountBinding *int
	OnHitCallback   A.FlagEventHandler
}

func (*Flag) Argument

func (f *Flag) Argument() A.Argument

func (*Flag) HasArgument

func (f *Flag) HasArgument() bool

func (*Flag) HasLong

func (f *Flag) HasLong() bool

func (*Flag) HasShort

func (f *Flag) HasShort() bool

func (*Flag) Hits

func (f *Flag) Hits() int

func (*Flag) IncrementHits

func (f *Flag) IncrementHits()

func (*Flag) Long

func (f *Flag) Long() string

func (*Flag) Parent

func (f *Flag) Parent() A.FlagGroup

func (*Flag) Required

func (f *Flag) Required() bool

func (*Flag) Short

func (f *Flag) Short() byte

func (*Flag) String

func (f *Flag) String() (out string)

type GBuilder

type GBuilder struct {
	ParentNode  A.Command
	NameTxt     trait.Named
	DescTxt     trait.Described
	FlagNodes   []A.FlagBuilder
	WarningVals []string
}

func (*GBuilder) Build

func (f *GBuilder) Build() (out A.FlagGroup, err error)

func (*GBuilder) Description

func (f *GBuilder) Description(desc string) A.FlagGroupBuilder

func (*GBuilder) Flag

func (f *GBuilder) Flag(flag A.FlagBuilder) A.FlagGroupBuilder

func (*GBuilder) GetDescription

func (f *GBuilder) GetDescription() string

func (*GBuilder) GetFlags

func (f *GBuilder) GetFlags() []A.FlagBuilder

func (*GBuilder) GetName

func (f *GBuilder) GetName() string

func (*GBuilder) MustBuild

func (f *GBuilder) MustBuild() A.FlagGroup

func (*GBuilder) Name

func (f *GBuilder) Name(name string) A.FlagGroupBuilder

func (*GBuilder) Parent

func (f *GBuilder) Parent(com A.Command) A.FlagGroupBuilder

type Group

type Group struct {
	trait.Named
	trait.Described

	ParentElement A.Command

	FlagNodes []A.Flag
}

func (*Group) Flags

func (f *Group) Flags() []A.Flag

func (*Group) HasFlags

func (f *Group) HasFlags() bool

func (*Group) Parent

func (f *Group) Parent() A.Command