opts

Documentation

Index

• Variables
• type Command
  • func Cmd(name, desc, doc string, op Op, cfg map[string]config.Option, cmds ...*Command) (c *Command)
  • func Init(c *Command) *Command
  • func (c *Command) Foreach(cl func(*Command, int) bool, hereDepth, hereDist int, cmd *Command) (ocl func(*Command, int) bool, depth, dist int, cm *Command)
  • func (c *Command) GetOpt(path Path) (o config.Option)
  • func (c *Command) MarshalText() (text []byte, err error)
  • func (c *Command) UnmarshalText(t []byte) (err error)
• type Commands
• type Entries
  • func (e Entries) Len() int
  • func (e Entries) Less(i, j int) bool
  • func (e Entries) Swap(i, j int)
• type Entry
  • func (e Entry) String() string
• type Op
• type Path
  • func (p Path) String() string

Variables

var NoOp = func(c interface{}) error { return nil }

var Tags = func(s ...string) []string {
	return s
}

Types

type Command

type Command struct {
	Name          string
	Description   string
	Documentation string
	Entrypoint    Op
	Parent        *Command
	Commands      Commands
	Configs       config.Opts
	sync.Mutex
}

Command is a specification for a command and can include any number of subcommands, and for each Command a list of options

func Cmd

func Cmd(name, desc, doc string, op Op, cfg map[string]config.Option,
	cmds ...*Command) (c *Command)

func Init

func Init(c *Command) *Command

func (*Command) Foreach

func (c *Command) Foreach(cl func(*Command, int) bool, hereDepth, hereDist int,
	cmd *Command) (ocl func(*Command, int) bool, depth, dist int,
	cm *Command)

Foreach runs a closure on every node in the Commands tree, stopping if the closure returns false

func (*Command) GetOpt

func (c *Command) GetOpt(path Path) (o config.Option)

func (*Command) MarshalText

func (c *Command) MarshalText() (text []byte, err error)

func (*Command) UnmarshalText

func (c *Command) UnmarshalText(t []byte) (err error)

type Commands

type Commands []*Command

Commands are a slice of Command entries

type Entries

type Entries []Entry

func (Entries) Len

func (e Entries) Len() int

func (Entries) Less

func (e Entries) Less(i, j int) bool

func (Entries) Swap

func (e Entries) Swap(i, j int)

type Entry

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

func (Entry) String

func (e Entry) String() string

type Op

type Op func(c interface{}) error

type Path

type Path []string

func (Path) String

func (p Path) String() string