Struct Error 

pub struct Error {
    pub kind: ErrorKind,
    pub code: String,
    pub message: String,
    pub hint: Option<String>,
    pub exit_code: i32,
}

The error carried through every command. code is a stable snake_case identifier, hint is a runnable command when one exists.

Fields

kind: ErrorKind

code: String

message: String

hint: Option<String>

exit_code: i32

Implementations

impl Error

pub fn new( kind: ErrorKind, code: impl Into<String>, message: impl Into<String>, ) -> Self

pub fn with_hint(self, hint: impl Into<String>) -> Self

pub fn usage(message: impl Into<String>) -> Self

pub fn processing(message: impl Into<String>) -> Self

pub fn input(message: impl Into<String>) -> Self

pub fn unsupported(message: impl Into<String>) -> Self

pub fn internal(message: impl Into<String>) -> Self

pub fn verification(message: impl Into<String>) -> Self

pub fn plugin(message: impl Into<String>) -> Self

pub fn cancelled(message: impl Into<String>) -> Self

Trait Implementations

impl Clone for Error

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 Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl Serialize for Error

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

where __S: Serializer,

Serialize this value into the given Serde serializer.