cmdtable

Documentation

Overview

Package cmdtable implements tools to look up chat commands in a table.

Index

• type CommandContext
• type Inserter
  • func (i *Inserter[E]) Insert(cmd []byte, cc *CommandContext[E])
• type Table
  • func New[Executor any]() *Table[Executor]
  • func (tab *Table[E]) Command(cc *CommandContext[E])
  • func (tab *Table[E]) Commands(ccs []*CommandContext[E])
  • func (tab *Table[E]) Dynamic(f func(*Inserter[E]))
  • func (tab *Table[E]) Lookup(isprefix bool, payload string) (cc *CommandContext[E], argstart int)

Types

type CommandContext

type CommandContext[Executor any] struct {
	Command      commands.Command
	ArgValidator *regexp.Regexp
	Executor     Executor
	Tag          string // TODO: should probably be in ipc.Command
}

A CommandContext holds information on a command.

type Inserter

type Inserter[E any] struct {
	// contains filtered or unexported fields
}

An Inserter is used to insert multiple commands into the table in a single transaction.

func (*Inserter[E]) Insert

func (i *Inserter[E]) Insert(cmd []byte, cc *CommandContext[E])

type Table

type Table[Executor any] struct {
	// contains filtered or unexported fields
}

func New

func New[Executor any]() *Table[Executor]

func (*Table[E]) Command

func (tab *Table[E]) Command(cc *CommandContext[E])

func (*Table[E]) Commands

func (tab *Table[E]) Commands(ccs []*CommandContext[E])

func (*Table[E]) Dynamic

func (tab *Table[E]) Dynamic(f func(*Inserter[E]))

Dynamic replaces the current dynamically loaded commands in the table.

func (*Table[E]) Lookup

func (tab *Table[E]) Lookup(isprefix bool, payload string) (cc *CommandContext[E], argstart int)

Lookup returns the CommandContext entry if the given payload is a command.