readline

package
v0.5.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 9, 2024 License: MIT Imports: 6 Imported by: 31

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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) AtDefault added in v0.5.0

func (a Args) AtDefault(v int, fallback string) string

func (Args) Empty

func (a Args) Empty() bool

func (Args) From added in v0.4.1

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 added in v0.3.0

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 added in v0.1.4

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

func (Args) Slice added in v0.3.0

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

func (Args) Splice added in v0.3.0

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

func (Args) To added in v0.4.1

func (a Args) To(end int) Args

type FlagSet

type FlagSet struct {
	*pflag.FlagSet
}

func NewFlagSet

func NewFlagSet(name string) *FlagSet

func (*FlagSet) GetValues added in v0.3.0

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

func (*FlagSet) SetValues added in v0.3.0

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

func (*FlagSet) Visited added in v0.4.0

func (s *FlagSet) Visited() Flags

type FlagSets added in v0.4.0

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

func NewFlagSets added in v0.4.0

func NewFlagSets() *FlagSets

func (*FlagSets) All added in v0.4.0

func (s *FlagSets) All() *FlagSet

func (*FlagSets) Default added in v0.4.0

func (s *FlagSets) Default() *FlagSet

func (*FlagSets) Get added in v0.4.0

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

func (*FlagSets) Internal added in v0.4.0

func (s *FlagSets) Internal() *FlagSet

func (*FlagSets) Parse added in v0.4.0

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

func (*FlagSets) ParseAll added in v0.4.0

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

func (*FlagSets) Visit added in v0.4.0

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

func (*FlagSets) VisitAll added in v0.4.0

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

func (*FlagSets) Visited added in v0.4.0

func (s *FlagSets) Visited() Flags

type Flags added in v0.4.0

type Flags []*pflag.Flag

func (Flags) Args added in v0.4.0

func (f Flags) Args() Args

func (Flags) Remove added in v0.4.0

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

func (Flags) Slice added in v0.4.0

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

func (Flags) Splice added in v0.4.0

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 added in v0.4.0

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 added in v0.4.0

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 added in v0.4.0

func (a *Readline) ParseFlagSets() error

func (*Readline) SetFlagSets added in v0.4.0

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

func (*Readline) String

func (a *Readline) String() string

func (*Readline) VisitedFlags

func (a *Readline) VisitedFlags() Flags

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL