Struct serenity::framework::standard::Check

pub struct Check {
    pub name: &'static str,
    pub function: CheckFunction,
    pub check_in_help: bool,
    pub display_in_help: bool,
}

A check can be part of a command or group and will be executed to determine whether a user is permitted to use related item.

Additionally, a check may hold additional settings.

Fields

name: &'static str

Name listed in help-system.

function: CheckFunction

Function that will be executed.

check_in_help: bool

Whether a check should be evaluated in the help-system. false will ignore check and won't fail execution.

display_in_help: bool

Whether a check shall be listed in the help-system. false won't affect whether the check will be evaluated help, solely check_in_help sets this.

Trait Implementations

impl PartialEq<Check> for Check

fn eq(&self, other: &Self) -> 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 Debug for Check

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

Formats the value using the given formatter.