Enum serenity::framework::standard::HelpBehaviour

pub enum HelpBehaviour {
    Nothing,
    Strike,
    Hide,
    // some variants omitted
}

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

Nothing

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

Strike

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

Hide

Does not list a command in the help-menu.

Trait Implementations

impl Clone for HelpBehaviour

fn clone(&self) -> HelpBehaviour

Returns a copy of the value.

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

Performs copy-assignment from source.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<HelpBehaviour> for HelpBehaviour

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl PartialEq<HelpBehaviour> for HelpBehaviour

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for HelpBehaviour

impl Eq for HelpBehaviour

impl Debug for HelpBehaviour

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

Formats the value using the given formatter.