readline

Documentation

Index

• type Arg
  • func (a Arg) IsAdditional() bool
  • func (a Arg) IsFlag() bool
  • func (a Arg) IsPass() bool
  • func (a Arg) IsPipe() bool
  • func (a Arg) IsRedirect() bool
  • func (a Arg) String() string
• type Args
  • func (a Args) At(v int) string
  • func (a Args) Empty() bool
  • func (a Args) From(start int) Args
  • func (a Args) Has(v string) bool
  • func (a Args) HasIndex(v int) bool
  • func (a Args) IndexOf(v string) int
  • func (a Args) Last() string
  • func (a Args) Len() int
  • func (a Args) LenGt(v int) bool
  • func (a Args) LenGte(v int) bool
  • func (a Args) LenIs(v int) bool
  • func (a Args) LenLt(v int) bool
  • func (a Args) LenLte(v int) bool
  • func (a Args) Shift() (string, Args)
  • func (a Args) Slice(start, end int) Args
  • func (a Args) Splice(start, num int) Args
  • func (a Args) To(end int) Args
• type FlagSet
  • func NewFlagSet(name string) *FlagSet
  • func (s *FlagSet) GetValues(name string) []string
  • func (s *FlagSet) SetValues(name string, values ...string) error
  • func (s *FlagSet) Visited() Flags
• type FlagSets
  • func NewFlagSets() *FlagSets
  • func (s *FlagSets) All() *FlagSet
  • func (s *FlagSets) Default() *FlagSet
  • func (s *FlagSets) Get(name string) *FlagSet
  • func (s *FlagSets) Internal() *FlagSet
  • func (s *FlagSets) Parse(arguments []string) error
  • func (s *FlagSets) ParseAll(arguments []string, fn func(flag *pflag.Flag, value string) error) error
  • func (s *FlagSets) Visit(fn func(*pflag.Flag)) Flags
  • func (s *FlagSets) VisitAll(fn func(*pflag.Flag)) Flags
  • func (s *FlagSets) Visited() Flags
• type Flags
  • func (f Flags) Args() Args
  • func (f Flags) Remove(name string) (*pflag.Flag, Flags)
  • func (f Flags) Slice(start, end int) Flags
  • func (f Flags) Splice(start, num int) Flags
• type Mode
• type Option
  • func WithRegex(v *regexp.Regexp) Option
• type Readline
  • func New(l log.Logger, opts ...Option) (*Readline, error)
  • func (a *Readline) AdditionalArgs() Args
  • func (a *Readline) AdditionalFlags() Args
  • func (a *Readline) AllFlags() []*pflag.Flag
  • func (a *Readline) Args() Args
  • func (a *Readline) Cmd() string
  • func (a *Readline) FlagSets() *FlagSets
  • func (a *Readline) Flags() Args
  • func (a *Readline) IsModeAdditional() bool
  • func (a *Readline) IsModeDefault() bool
  • func (a *Readline) Mode() Mode
  • func (a *Readline) Parse(input string) error
  • func (a *Readline) ParseFlagSets() error
  • func (a *Readline) SetFlagSets(fs *FlagSets)
  • func (a *Readline) String() string
  • func (a *Readline) VisitedFlags() Flags

Types

type Arg

type Arg string

func (Arg) IsAdditional

func (a Arg) IsAdditional() bool

func (Arg) IsFlag

func (a Arg) IsFlag() bool

func (Arg) IsPass

func (a Arg) IsPass() bool

func (Arg) IsPipe

func (a Arg) IsPipe() bool

func (Arg) IsRedirect

func (a Arg) IsRedirect() bool

func (Arg) String

func (a Arg) String() string

type Args

type Args []string

func (Args) At

func (a Args) At(v int) string

func (Args) Empty

func (a Args) Empty() bool

func (Args) From

func (a Args) From(start int) Args

func (Args) Has

func (a Args) Has(v string) bool

func (Args) HasIndex

func (a Args) HasIndex(v int) bool

func (Args) IndexOf

func (a Args) IndexOf(v string) int

func (Args) Last

func (a Args) Last() string

func (Args) Len

func (a Args) Len() int

func (Args) LenGt

func (a Args) LenGt(v int) bool

func (Args) LenGte

func (a Args) LenGte(v int) bool

func (Args) LenIs

func (a Args) LenIs(v int) bool

func (Args) LenLt

func (a Args) LenLt(v int) bool

func (Args) LenLte

func (a Args) LenLte(v int) bool

func (Args) Shift

func (a Args) Shift() (string, Args)

func (Args) Slice

func (a Args) Slice(start, end int) Args

func (Args) Splice

func (a Args) Splice(start, num int) Args

func (Args) To

func (a Args) To(end int) Args

type FlagSet

type FlagSet struct {
	*pflag.FlagSet
}

func NewFlagSet

func NewFlagSet(name string) *FlagSet

func (*FlagSet) GetValues

func (s *FlagSet) GetValues(name string) []string

func (*FlagSet) SetValues

func (s *FlagSet) SetValues(name string, values ...string) error

func (*FlagSet) Visited

func (s *FlagSet) Visited() Flags

type FlagSets

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

func NewFlagSets

func NewFlagSets() *FlagSets

func (*FlagSets) All

func (s *FlagSets) All() *FlagSet

func (*FlagSets) Default

func (s *FlagSets) Default() *FlagSet

func (*FlagSets) Get

func (s *FlagSets) Get(name string) *FlagSet

func (*FlagSets) Internal

func (s *FlagSets) Internal() *FlagSet

func (*FlagSets) Parse

func (s *FlagSets) Parse(arguments []string) error

func (*FlagSets) ParseAll

func (s *FlagSets) ParseAll(arguments []string, fn func(flag *pflag.Flag, value string) error) error

func (*FlagSets) Visit

func (s *FlagSets) Visit(fn func(*pflag.Flag)) Flags

func (*FlagSets) VisitAll

func (s *FlagSets) VisitAll(fn func(*pflag.Flag)) Flags

func (*FlagSets) Visited

func (s *FlagSets) Visited() Flags

type Flags

type Flags []*pflag.Flag

func (Flags) Args

func (f Flags) Args() Args

func (Flags) Remove

func (f Flags) Remove(name string) (*pflag.Flag, Flags)

func (Flags) Slice

func (f Flags) Slice(start, end int) Flags

func (Flags) Splice

func (f Flags) Splice(start, num int) Flags

type Mode

type Mode string

const (
	ModeArgs           Mode = "args"
	ModeFlags          Mode = "flags"
	ModeAdditionalArgs Mode = "additional"
)

type Option

type Option func(*Readline) error

func WithRegex

func WithRegex(v *regexp.Regexp) Option

type Readline

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

func New

func New(l log.Logger, opts ...Option) (*Readline, error)

func (*Readline) AdditionalArgs

func (a *Readline) AdditionalArgs() Args

func (*Readline) AdditionalFlags

func (a *Readline) AdditionalFlags() Args

func (*Readline) AllFlags

func (a *Readline) AllFlags() []*pflag.Flag

func (*Readline) Args

func (a *Readline) Args() Args

func (*Readline) Cmd

func (a *Readline) Cmd() string

func (*Readline) FlagSets

func (a *Readline) FlagSets() *FlagSets

func (*Readline) Flags

func (a *Readline) Flags() Args

func (*Readline) IsModeAdditional

func (a *Readline) IsModeAdditional() bool

func (*Readline) IsModeDefault

func (a *Readline) IsModeDefault() bool

func (*Readline) Mode

func (a *Readline) Mode() Mode

func (*Readline) Parse

func (a *Readline) Parse(input string) error

func (*Readline) ParseFlagSets

func (a *Readline) ParseFlagSets() error

func (*Readline) SetFlagSets

func (a *Readline) SetFlagSets(fs *FlagSets)

func (*Readline) String

func (a *Readline) String() string

func (*Readline) VisitedFlags

func (a *Readline) VisitedFlags() Flags