router

Documentation

Index

• type Leaf
  • func NewLeaf(com comm.Command) *Leaf
• type Router
  • func NewRouter() *Router
  • func (r *Router) AddCommand(com comm.Command)
  • func (r *Router) Route(argv []string) (comm.Command, int)
  • func (r *Router) ToSlice() []comm.Command
  • func (r *Router) ToStringSlice() []string

Types

type Leaf

type Leaf struct {
	Command comm.Command
	Leaves  map[string]*Leaf
}

Leaf is a leaf of the command router tree.

func NewLeaf

func NewLeaf(com comm.Command) *Leaf

NewLeaf returns a Leaf with the command.

type Router

type Router struct {
	Routes *Leaf
}

Router routes a command string to a command.

func NewRouter

func NewRouter() *Router

NewRouter returns a new Router structure.

func (*Router) AddCommand

func (r *Router) AddCommand(com comm.Command)

AddCommand adds command-string mapping

func (*Router) Route

func (r *Router) Route(argv []string) (comm.Command, int)

Route routes to handler from string. Returns the command and the number of matched args. e.g.

	   // r has a route through "example"->"command"->"string"
    com, ind := r.Route([]string{"example", "command", "string", "with", "args"})

`com` will contain the command at "string" leaf `ind` will be 3

func (*Router) ToSlice

func (r *Router) ToSlice() []comm.Command

ToSlice searches the tree and populates a slice of Commands sorted by the first alias name

Duplicates are removed in case you were wondering

func (*Router) ToStringSlice

func (r *Router) ToStringSlice() []string

ToStringSlice wraps ToSlice and populates a strings slice of aliases