subcmd

Documentation

Index

• Variables
• type Cmd
• type Error
  • func DefaultRunner(c Cmd, args []string) *Error
  • func Run(args []string, cont RunnerFunc) *Error
  • func (e *Error) Error() string
• type RunnerFunc

Variables

var ErrShowedHelp = errors.New("already showed help")

ErrShowedHelp is used in parsing argument function of subcommand when the subcommand showed help. Then caller can exit successfully and silently.

Types

type Cmd

type Cmd interface {
	ProhibitRootExecution(args []string) bool
	Run(args []string) *Error
	FlagSet() *flag.FlagSet
}

Cmd represents volt's subcommand interface. All subcommands must implement this.

type Error

type Error struct {
	Code int
	Msg  string
}

Error is a command error. It also has a exit code.

func DefaultRunner

func DefaultRunner(c Cmd, args []string) *Error

DefaultRunner simply runs command with args

func Run

func Run(args []string, cont RunnerFunc) *Error

Run is invoked by main(), each argument means 'volt {subcmd} {args}'.

func (*Error) Error

func (e *Error) Error() string

type RunnerFunc

type RunnerFunc func(c Cmd, args []string) *Error

RunnerFunc invokes c with args. On unit testing, a mock function was given.