Enum serenity::framework::standard::help_commands::CustomisedHelpData

pub enum CustomisedHelpData<'a> {
    SuggestedCommands {
        help_description: String,
        suggestions: Suggestions,
    },
    GroupedCommands {
        help_description: String,
        groups: Vec<GroupCommandsPair>,
    },
    SingleCommand {
        command: Command<'a>,
    },
    NoCommandFound {
        help_error_message: &'a str,
    },
    // some variants omitted
}

Covers possible outcomes of a help-request and yields relevant data in customised textual representation.

Variants

SuggestedCommands

To display suggested commands.

Fields of SuggestedCommands

help_description: Stringsuggestions: Suggestions

GroupedCommands

To display groups and their commands by name.

Fields of GroupedCommands

help_description: Stringgroups: Vec<GroupCommandsPair>

SingleCommand

To display one specific command.

Fields of SingleCommand

command: Command<'a>

NoCommandFound

To display failure in finding a fitting command.

Fields of NoCommandFound

help_error_message: &'a str

Trait Implementations

impl<'a> Clone for CustomisedHelpData<'a>

fn clone(&self) -> CustomisedHelpData<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for CustomisedHelpData<'a>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.