[][src]Module serenity::framework::standard

Modules

buckets
help_commands

A collection of default help commands for the framework.

macros

Structs

Args

A utility struct for handling "arguments" of a command.

BucketBuilder
Check

A check can be part of a command or group and will be executed to determine whether a user is permitted to use related item.

Command
CommandError
CommandGroup
CommandOptions
Configuration

The configuration to use for a StandardFramework associated with a Client instance.

GroupOptions
HelpCommand
HelpOptions
Iter

Parse each argument individually, as an iterator.

StandardFramework

A utility for easily managing dispatches to commands.

Enums

ArgError

Defines how an operation on an Args method failed.

CheckResult

Returned from Checks. If Success, the Check is considered as passed. If Failure, the Check is considered as failed and can return further information on the cause via Reason.

Delimiter

Dictates how Args should split arguments, if by one character, or a string.

DispatchError

An enum representing all possible fail conditions under which a command won't be executed.

HelpBehaviour

Describes the behaviour the help-command shall execute once it encounters a command which the user or command fails to meet following criteria : Lacking required permissions to execute the command. Lacking required roles to execute the command. The command can't be used in the current channel (as in DM only or guild only).

OnlyIn
Reason

This type describes why a check has failed and occurs on CheckResult::Failure.

Traits

CommonOptions

Type Definitions

CheckFunction
CommandFn
CommandResult
DispatchHook
HelpCommandFn