pub struct HelpOptions {Show 29 fields
pub names: &'static [&'static str],
pub suggestion_text: &'static str,
pub no_help_available_text: &'static str,
pub usage_label: &'static str,
pub usage_sample_label: &'static str,
pub ungrouped_label: &'static str,
pub description_label: &'static str,
pub grouped_label: &'static str,
pub aliases_label: &'static str,
pub guild_only_text: &'static str,
pub checks_label: &'static str,
pub sub_commands_label: &'static str,
pub dm_only_text: &'static str,
pub dm_and_guild_text: &'static str,
pub available_text: &'static str,
pub command_not_found_text: &'static str,
pub individual_command_tip: &'static str,
pub strikethrough_commands_tip_in_dm: Option<&'static str>,
pub strikethrough_commands_tip_in_guild: Option<&'static str>,
pub group_prefix: &'static str,
pub lacking_role: HelpBehaviour,
pub lacking_permissions: HelpBehaviour,
pub lacking_ownership: HelpBehaviour,
pub lacking_conditions: HelpBehaviour,
pub wrong_channel: HelpBehaviour,
pub embed_error_colour: Colour,
pub embed_success_colour: Colour,
pub max_levenshtein_distance: usize,
pub indention_prefix: &'static str,
}poise for command handlingframework and standard_framework only.Fields§
§names: &'static [&'static str]poise for command handlingWhich names should the help command use for dispatching.
Defaults to ["help"]
suggestion_text: &'static strpoise for command handlingSuggests a command’s name.
no_help_available_text: &'static strpoise for command handlingIf no help is available, this text will be displayed.
usage_label: &'static strpoise for command handlingHow to use a command, {usage_label}: {command_name} {args}
usage_sample_label: &'static strpoise for command handlingActual sample label, {usage_sample_label}: {command_name} {args}
ungrouped_label: &'static strpoise for command handlingText labeling ungrouped commands, {ungrouped_label}: ...
description_label: &'static strpoise for command handlingText labeling the start of the description.
grouped_label: &'static strpoise for command handlingText labeling grouped commands, {grouped_label} {group_name}: ...
aliases_label: &'static strpoise for command handlingText labeling a command’s alternative names (aliases).
guild_only_text: &'static strpoise for command handlingText specifying that a command is only usable in a guild.
checks_label: &'static strpoise for command handlingText labelling a command’s names of checks.
sub_commands_label: &'static strpoise for command handlingText labelling a command’s subcommands
dm_only_text: &'static strpoise for command handlingText specifying that a command is only usable in via DM.
dm_and_guild_text: &'static strpoise for command handlingText specifying that a command can be used via DM and in guilds.
available_text: &'static strpoise for command handlingText expressing that a command is available.
command_not_found_text: &'static strpoise for command handlingError-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: &'static strpoise for command handlingExplains the user on how to use access a single command’s details.
strikethrough_commands_tip_in_dm: Option<&'static str>poise for command handlingExplains 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 the help macro.
Note: Text is only used in direct messages.
strikethrough_commands_tip_in_guild: Option<&'static str>poise for command handlingExplains 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 the help macro.
Note: Text is only used in guilds.
group_prefix: &'static strpoise for command handlingAnnouncing a group’s prefix as in: {group_prefix} {prefix}.
lacking_role: HelpBehaviourpoise for command handlingIf a user lacks required roles, this will treat how these commands will be displayed.
lacking_permissions: HelpBehaviourpoise for command handlingIf a user lacks permissions, this will treat how these commands will be displayed.
lacking_ownership: HelpBehaviourpoise for command handlingIf a user lacks ownership, this will treat how these commands will be displayed.
lacking_conditions: HelpBehaviourpoise for command handlingIf conditions (of a check) may be lacking by the user, this will treat how these commands will be displayed.
wrong_channel: HelpBehaviourpoise for command handlingIf a user is using the help-command in a channel where a command is not available, this behaviour will be executed.
embed_error_colour: Colourpoise for command handlingColour help-embed will use upon encountering an error.
embed_success_colour: Colourpoise for command handlingColour help-embed will use if no error occurred.
max_levenshtein_distance: usizepoise for command handlingIf not 0, help will check whether a command is similar to searched named.
indention_prefix: &'static strpoise for command handlingHelp will use this as prefix to express how deeply nested a command or group is.
Trait Implementations§
Source§impl Clone for HelpOptions
impl Clone for HelpOptions
Source§fn clone(&self) -> HelpOptions
fn clone(&self) -> HelpOptions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for HelpOptions
impl Debug for HelpOptions
Source§impl PartialEq for HelpOptions
impl PartialEq for HelpOptions
impl Eq for HelpOptions
impl StructuralPartialEq for HelpOptions
Auto Trait Implementations§
impl Freeze for HelpOptions
impl RefUnwindSafe for HelpOptions
impl Send for HelpOptions
impl Sync for HelpOptions
impl Unpin for HelpOptions
impl UnwindSafe for HelpOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> CloneDebuggableStorage for Twhere
T: DebuggableStorage + Clone,
impl<T> CloneDebuggableStorage for Twhere
T: DebuggableStorage + Clone,
fn clone_storage(&self) -> Box<dyn CloneDebuggableStorage>
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> CloneableStorage for T
impl<T> CloneableStorage for T
fn clone_storage(&self) -> Box<dyn CloneableStorage>
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.