commands

Documentation

Overview

Package commands provides command handling capable of ingesting transport.Events and responding over the provided transport wire. If the userDB is set permissions on a command will be honored otherwise if no userDB is set permissions will be ignored entirely (this could possibly use improvement).

Index

• type Command
  • func (c *Command) AddCommand(cmd *Command)
  • func (c *Command) Children() []*Command
  • func (c *Command) Execute(ev *transport.Event) error
  • func (c *Command) Parent() *Command

Types

type Command

type Command struct {
	Use     string
	Aliases []string
	Short   string
	Long    string

	ExecFunc func(ev *transport.Event) error

	Perms    []string
	Disabled bool
	Hidden   bool

	UserDB users.DB
	// contains filtered or unexported fields
}

Command is the base for all commands.

func (*Command) AddCommand

func (c *Command) AddCommand(cmd *Command)

AddCommand adds a new Command to the current command as a child.

func (*Command) Children

func (c *Command) Children() []*Command

Children returns the children commands if there are any.

func (*Command) Execute

func (c *Command) Execute(ev *transport.Event) error

Execute executes the command using the provided event. It attempts to match the event against any children commands first allowing a base Command to act as a command tree.

func (*Command) Parent

func (c *Command) Parent() *Command

Parent returns the parent command if there is one.