command

Documentation

Index

• Variables
• type Command
• type Commands
• type Context
  • func NewContext() *Context
  • func (ctx *Context) Close() error
  • func (ctx *Context) Command() string
  • func (ctx *Context) Do(c Commands)
  • func (ctx *Context) Err() error
  • func (ctx *Context) Fatalf(format string, args ...interface{})
  • func (ctx *Context) Next() bool
  • func (ctx *Context) Output() io.Writer
  • func (ctx *Context) Printf(format string, args ...interface{})
  • func (ctx *Context) ReadHistory() (int, error)
  • func (ctx *Context) ReadLine(prompt string) (string, error)
  • func (ctx *Context) SetHistory(f string)
  • func (ctx *Context) SetOutput(w io.Writer)
  • func (ctx *Context) SetPrompt(f string)
  • func (ctx *Context) WriteHistory() (int, error)
• type Register
  • func NewRegister() Register
  • func NewRegisterWithDB(db *bolt.DB) Register
• type Usage
• type ValidateFunc
• type Validates
  • func NewValidats() Validates
  • func (v Validates) Append(f ValidateFunc) Validates
  • func (v Validates) Choices(pos int, choices []string) Validates
  • func (v Validates) Finish() ValidateFunc
  • func (v Validates) MaxArgs(n int) Validates
  • func (v Validates) MinArgs(n int) Validates
  • func (v Validates) NumArgs(n int) Validates
  • func (v Validates) NumArgsChoice(n ...int) Validates

Variables

var (
	HistoryFile string
	MaxLines    = 65536
	Prompt      = ">> "
)

Types

type Command

type Command interface {
	Alias() []string
	Help() string
	Execute(ctx *Context, args []string) error
	Check(ctx *Context, args []string) error
}

type Commands

type Commands interface {
	Execute(ctx *Context, cmd string) error
}

type Context

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

func NewContext

func NewContext() *Context

func (*Context) Close

func (ctx *Context) Close() error

func (*Context) Command

func (ctx *Context) Command() string

func (*Context) Do

func (ctx *Context) Do(c Commands)

func (*Context) Err

func (ctx *Context) Err() error

func (*Context) Fatalf

func (ctx *Context) Fatalf(format string, args ...interface{})

func (*Context) Next

func (ctx *Context) Next() bool

func (*Context) Output

func (ctx *Context) Output() io.Writer

func (*Context) Printf

func (ctx *Context) Printf(format string, args ...interface{})

func (*Context) ReadHistory

func (ctx *Context) ReadHistory() (int, error)

func (*Context) ReadLine

func (ctx *Context) ReadLine(prompt string) (string, error)

func (*Context) SetHistory

func (ctx *Context) SetHistory(f string)

func (*Context) SetOutput

func (ctx *Context) SetOutput(w io.Writer)

func (*Context) SetPrompt

func (ctx *Context) SetPrompt(f string)

func (*Context) WriteHistory

func (ctx *Context) WriteHistory() (int, error)

type Register

type Register interface {
	Commands
	Register(Command)
}

func NewRegister

func NewRegister() Register

func NewRegisterWithDB

func NewRegisterWithDB(db *bolt.DB) Register

type Usage

type Usage interface {
	Usage() string
}

type ValidateFunc

type ValidateFunc func(ctx *Context, args []string) error

type Validates

type Validates []ValidateFunc

func NewValidats

func NewValidats() Validates

func (Validates) Append

func (v Validates) Append(f ValidateFunc) Validates

func (Validates) Choices

func (v Validates) Choices(pos int, choices []string) Validates

func (Validates) Finish

func (v Validates) Finish() ValidateFunc

func (Validates) MaxArgs

func (v Validates) MaxArgs(n int) Validates

func (Validates) MinArgs

func (v Validates) MinArgs(n int) Validates

func (Validates) NumArgs

func (v Validates) NumArgs(n int) Validates

func (Validates) NumArgsChoice

func (v Validates) NumArgsChoice(n ...int) Validates