Struct Check

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

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

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

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

Name listed in help-system.

function: CheckFunction

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

Function that will be executed.

check_in_help: bool

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

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

display_in_help: bool

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

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

Trait Implementations

impl Debug for Check

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

Formats the value using the given formatter.

impl PartialEq for Check

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