Enum CommandError 

pub enum CommandError {
    Unknown {
        id: String,
    },
    Disabled {
        id: String,
        reason: String,
    },
    BadParams {
        id: String,
        msg: String,
    },
    Failed {
        id: String,
        msg: String,
    },
    Panicked {
        id: String,
    },
}

CONTRACT: why a command failed. Hosts wrap their own errors in CommandError::Failed.

Variants

Unknown

Fields

id: String

Disabled

Fields

id: String

reason: String

BadParams

Fields

id: String

msg: String

Failed

Fields

id: String

msg: String

Panicked

Fields

id: String

Implementations

impl CommandError

pub fn id(&self) -> &str

The command the error is about.

pub fn failed(id: impl Into<String>, msg: impl Into<String>) -> Self

pub fn bad_params(id: impl Into<String>, msg: impl Into<String>) -> Self

pub fn or_id(self, command: &str) -> Self

Fill in the command id when the error was built without one (a host error converted with From, which does not know which command it came from).

Trait Implementations

impl Clone for CommandError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CommandError

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

Formats the value using the given formatter.

impl Error for CommandError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl PartialEq for CommandError

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CommandError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandError