Enum serenity::framework::standard::CheckResult

pub enum CheckResult {
    Success,
    Failure(Reason),
}

Returned from Checks. If Success, the Check is considered as passed. If Failure, the Check is considered as failed and can return further information on the cause via Reason.

Variants

SuccessFailure(Reason)

Methods

impl CheckResult

pub fn new_user<D>(d: D) -> Self where
    D: Display, 

Creates a new CheckResult::Failure with Reason::User.

pub fn new_log<D>(d: D) -> Self where
    D: Display, 

Creates a new CheckResult::Failure with Reason::Log.

pub fn new_unknown() -> Self

Creates a new CheckResult::Failure with Reason::Unknown.

pub fn new_user_and_log<D>(user: D, log: D) -> Self where
    D: Display, 

Creates a new CheckResult::Failure with Reason::UserAndLog.

pub fn is_success(&self) -> bool

Returns true if CheckResult is CheckResult::Success and false if not.

Trait Implementations

impl Clone for CheckResult

fn clone(&self) -> CheckResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<bool> for CheckResult

fn from(succeeded: bool) -> Self

Performs the conversion.

impl From<Reason> for CheckResult

fn from(reason: Reason) -> Self

Performs the conversion.

impl Debug for CheckResult

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

Formats the value using the given formatter.