Enum serenity::framework::standard::Reason

pub enum Reason {
    Unknown,
    User(String),
    Log(String),
    UserAndLog {
        user: String,
        log: String,
    },
    // some variants omitted
}

This type describes why a check has failed and occurs on CheckResult::Failure.

Note: The bot-developer is supposed to process this enum as the framework is not. It solely serves as a way to inform a user about why a check has failed and for the developer to log given failure (e.g. bugs or statstics) occurring in Checks.

Variants

Unknown

No information on the failure.

User(String)

Information dedicated to the user.

Log(String)

Information purely for logging purposes.

UserAndLog

Information for the user but also for logging purposes.

Fields of UserAndLog

user: Stringlog: String

Trait Implementations

impl Clone for Reason

fn clone(&self) -> Reason

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Reason> for CheckResult

fn from(reason: Reason) -> Self

Performs the conversion.

impl Debug for Reason

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

Formats the value using the given formatter.