Struct serenity::framework::standard::HelpOptions

pub struct HelpOptions {
    pub suggestion_text: String,
    pub no_help_available_text: String,
    pub usage_label: String,
    pub usage_sample_label: String,
    pub ungrouped_label: String,
    pub description_label: String,
    pub grouped_label: String,
    pub aliases_label: String,
    pub guild_only_text: String,
    pub dm_only_text: String,
    pub dm_and_guild_text: String,
    pub available_text: String,
    pub command_not_found_text: String,
    pub individual_command_tip: String,
    pub striked_commands_tip_in_dm: Option<String>,
    pub striked_commands_tip_in_guild: Option<String>,
    pub group_prefix: String,
    pub lacking_role: HelpBehaviour,
    pub lacking_permissions: HelpBehaviour,
    pub wrong_channel: HelpBehaviour,
    pub embed_error_colour: Colour,
    pub embed_success_colour: Colour,
    pub max_levenshtein_distance: usize,
}

Fields

suggestion_text: String

Suggests a command's name.

no_help_available_text: String

If no help is available, this text will be displayed.

usage_label: String

How to use a command, {usage_label}: {command_name} {args}

usage_sample_label: String

Actual sample label, {usage_sample_label}: {command_name} {args}

ungrouped_label: String

Text labeling ungrouped commands, {ungrouped_label}: ...

description_label: String

Text labeling the start of the description.

grouped_label: String

Text labeling grouped commands, {grouped_label} {group_name}: ...

aliases_label: String

Text labeling a command's alternative names (aliases).

guild_only_text: String

Text specifying that a command is only usable in a guild.

dm_only_text: String

Text specifying that a command is only usable in via DM.

dm_and_guild_text: String

Text specifying that a command can be used via DM and in guilds.

available_text: String

Text expressing that a command is available.

command_not_found_text: String

Error-message once a command could not be found. Output-example (without whitespace between both substitutions: {command_not_found_text}{command_name} {command_name} describes user's input as in: {prefix}help {command_name}.

individual_command_tip: String

Explains the user on how to use access a single command's details.

striked_commands_tip_in_dm: Option<String>

Explains reasoning behind strikethrough-commands, see fields requiring HelpBehaviour for further information. If HelpBehaviour::Strike is unused, this field will evaluate to None during creation inside of CreateHelpCommand.

Note: Text is only used in direct messages.

striked_commands_tip_in_guild: Option<String>

Explains reasoning behind strikethrough-commands, see fields requiring HelpBehaviour for further information. If HelpBehaviour::Strike is unused, this field will evaluate to None during creation inside of CreateHelpCommand.

Note: Text is only used in guilds.

group_prefix: String

Announcing a group's prefix as in: {group_prefix} {prefix}.

lacking_role: HelpBehaviour

If a user lacks required roles, this will treat how these commands will be displayed.

lacking_permissions: HelpBehaviour

If a user lacks permissions, this will treat how these commands will be displayed.

wrong_channel: HelpBehaviour

If a user is using the help-command in a channel where a command is not available, this behaviour will be executed.

embed_error_colour: Colour

Colour help-embed will use upon encountering an error.

embed_success_colour: Colour

Colour help-embed will use if no error occurred.

max_levenshtein_distance: usize

If not 0, help will check whether a command is similar to searched named.

Trait Implementations

impl Default for HelpOptions

fn default() -> HelpOptions

Returns the "default value" for a type.

impl Debug for HelpOptions

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

Formats the value using the given formatter.