Enum HelpBehaviour

#[non_exhaustive]
pub enum HelpBehaviour {
    Nothing,
    Strike,
    Hide,
}

👎Deprecated: The standard framework is deprecated, and will be removed in 0.13. Please migrate to poise for command handling

Available on crate features framework and standard_framework only.

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).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Nothing

👎Deprecated: The standard framework is deprecated, and will be removed in 0.13. Please migrate to poise for command handling

The command will be displayed, hence nothing will be done.

Strike

👎Deprecated: The standard framework is deprecated, and will be removed in 0.13. Please migrate to poise for command handling

Strikes a command by applying ~~{command_name}~~.

Hide

👎Deprecated: The standard framework is deprecated, and will be removed in 0.13. Please migrate to poise for command handling

Does not list a command in the help-menu.

Trait Implementations

impl Clone for HelpBehaviour

fn clone(&self) -> HelpBehaviour

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpBehaviour

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

Formats the value using the given formatter.

impl Ord for HelpBehaviour

fn cmp(&self, other: &HelpBehaviour) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HelpBehaviour

fn eq(&self, other: &HelpBehaviour) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for HelpBehaviour

fn partial_cmp(&self, other: &HelpBehaviour) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for HelpBehaviour

impl Eq for HelpBehaviour

impl StructuralPartialEq for HelpBehaviour