command

Documentation

Overview

Package command implements functions for responding to user input and dispatching to appropriate backend commands.

Index

• func CommandFunc(fn func() error) cmdfunc
• type Commands
  • func DebugCommands() *Commands
  • func (c *Commands) Find(cmdstr string) cmdfunc
  • func (c *Commands) Register(cmdstr string, cf cmdfunc, helpMsg string)

Functions

func CommandFunc

func CommandFunc(fn func() error) cmdfunc

Types

type Commands

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

func DebugCommands

func DebugCommands() *Commands

Returns a Commands struct with default commands defined.

func (*Commands) Find

func (c *Commands) Find(cmdstr string) cmdfunc

Find will look up the command function for the given command input. If it cannot find the command it will defualt to noCmdAvailable(). If the command is an empty string it will replay the last command.

func (*Commands) Register

func (c *Commands) Register(cmdstr string, cf cmdfunc, helpMsg string)

Register custom commands. Expects cf to be a func of type cmdfunc, returning only an error.