Struct error_chain::example_generated::Error

pub struct Error(pub ErrorKind, _);

The Error type.

This tuple struct is made of two elements:

• an ErrorKind which is used to determine the type of the error.
• An internal State, not meant for direct use outside of error_chain internals, containing:
  • a backtrace, generated when the error is created.
  • an error chain, used for the implementation of Error::cause().

Implementations

impl Error

pub fn from_kind(kind: ErrorKind) -> Error

Constructs an error from a kind, and generates a backtrace.

pub fn with_chain<E, K>(error: E, kind: K) -> Error where
    E: Error + Send + 'static,
    K: Into<ErrorKind>, 

Constructs a chained error from another error and a kind, and generates a backtrace.

pub fn with_boxed_chain<K>(error: Box<dyn Error + Send>, kind: K) -> Error where
    K: Into<ErrorKind>, 

Construct a chained error from another boxed error and a kind, and generates a backtrace

pub fn kind(&self) -> &ErrorKind

Returns the kind of the error.

pub fn iter(&self) -> Iter<'_>

Iterates over the error chain.

pub fn backtrace(&self) -> Option<&Backtrace>

Returns the backtrace associated with this error.

pub fn chain_err<F, EK>(self, error: F) -> Error where
    F: FnOnce() -> EK,
    EK: Into<ErrorKind>, 

Extends the error chain with a new entry.

pub fn description(&self) -> &str

A short description of the error. This method is identical to Error::description()

Trait Implementations

impl ChainedError for Error

type ErrorKind = ErrorKind

Associated kind type.

fn new(kind: ErrorKind, state: State) -> Error

fn from_kind(kind: Self::ErrorKind) -> Self

Constructs an error from a kind, and generates a backtrace.

fn with_chain<E, K>(error: E, kind: K) -> Self where
    E: Error + Send + 'static,
    K: Into<Self::ErrorKind>, 

Constructs a chained error from another error and a kind, and generates a backtrace.

fn kind(&self) -> &Self::ErrorKind

Returns the kind of the error.

fn iter(&self) -> Iter<'_>

Iterates over the error chain.

fn chain_err<F, EK>(self, error: F) -> Self where
    F: FnOnce() -> EK,
    EK: Into<ErrorKind>, 

Extends the error chain with a new entry.

fn backtrace(&self) -> Option<&Backtrace>

Returns the backtrace associated with this error.

fn extract_backtrace(
    e: &(dyn Error + Send + 'static)
) -> Option<InternalBacktrace>

fn display_chain<'a>(&'a self) -> DisplayChain<'a, Self>

Returns an object which implements Display for printing the full context of this error.

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)>

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<'a> From<&'a str> for Error

fn from(s: &'a str) -> Self

Performs the conversion.

impl From<Error> for Error

Link to another ErrorChain.

fn from(e: Error) -> Self

Performs the conversion.

impl From<Error> for Error

Link to a std::io::Error type.

fn from(e: Error) -> Self

Performs the conversion.

impl From<Error> for ErrorKind

fn from(e: Error) -> Self

Performs the conversion.

impl From<ErrorKind> for Error

fn from(e: ErrorKind) -> Self

Performs the conversion.

impl From<String> for Error

fn from(s: String) -> Self

Performs the conversion.