prefix

Documentation

Index

• Variables
• func Add(prefix string, t core.CommandType, place int64) (string, error, error)
• func Delete(prefix string, t core.CommandType, place int64) (error, error)
• func List(t core.CommandType, place int64) ([]core.Prefix, error)
• func Reset(place int64) error

Variables

var (
	ErrExists   = errors.New("The prefix already exists.")
	ErrNotFound = errors.New("The prefix was not found.")
	ErrOneLeft  = errors.New("Only one prefix is left.")

	ErrCustomCommandExists = errors.New("Can't add the prefix %s. A custom command with the name %s exists and would collide with the built-in command of the same name. Either change the custom command or use a different prefix.")
)

var Admin = admin{}

var AdminAdd = adminAdd{}

var AdminDelete = adminDelete{}

var AdminList = adminList{}

var AdminReset = adminReset{}

var Advanced = advanced{}

var AdvancedAdd = advancedAdd{}

var AdvancedDelete = advancedDelete{}

var AdvancedList = advancedList{}

var AdvancedReset = advancedReset{}

var Normal = normal{}

var NormalAdd = normalAdd{}

var NormalDelete = normalDelete{}

var NormalReset = normalReset{}

Functions

func Add

func Add(prefix string, t core.CommandType, place int64) (string, error, error)

Add adds a prefix of type t in the specified place. If the prefix, regardless of type, already exists then returns an ErrExists error. If a custom command happens to collide with the newly added prefix (for example if the custom command `.help` exists and the prefix `.` is added then `.help` would collide with the built-in command `help`) then returns an ErrCustomCommandExists error.

func Delete

func Delete(prefix string, t core.CommandType, place int64) (error, error)

Delete removes the prefix of type t from the specified place. If the prefix doesn't exist returns an ErrNotFound error. If there is only one prefix of that type left then returns an ErrOneLeft error.

func List

func List(t core.CommandType, place int64) ([]core.Prefix, error)

List returns a list of prefixes with type t in the specified place. It is possible to return prefixes of multiple types like so:

List(core.Normal|core.Advanced, place)

func Reset

func Reset(place int64) error

Reset wipes all the prefixes from the database making it so the default ones will have to be used.