Struct failure::Context

pub struct Context<D: Display + Send + Sync + 'static> { /* fields omitted */ }

An error with context around it.

The context is intended to be a human-readable, user-facing explanation for the error that has occurred. The underlying error is not assumed to be end-user-relevant information.

The Display impl for Context only prints the human-readable context, while the Debug impl also prints the underlying error.

Methods

impl<D: Display + Send + Sync + 'static> Context<D>

fn new(context: D) -> Context<D>

Creates a new context without an underlying error message.

fn get_context(&self) -> &D

Returns a reference to the context provided with this error.

Trait Implementations

impl<D: Display + Send + Sync + 'static> Fail for Context<D>

fn cause(&self) -> Option<&Fail>

Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors.

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

Returns a reference to the Backtrace carried by this failure, if it carries one.

fn context<D>(self, context: D) -> Context<D> where
    D: Display + Send + Sync + 'static,
    Self: Sized, 

Provides context for this failure.

fn compat(self) -> Compat<Self> where
    Self: Sized, 

Wraps this failure in a compatibility wrapper that implements std::error::Error.

fn causes(&self) -> Causes where
    Self: Sized, 

Returns a iterator over the causes of this Fail with itself as the first item and the root_cause as the final item.

fn root_cause(&self) -> &Fail where
    Self: Sized, 

Returns the "root cause" of this Fail - the last value in the cause chain which does not return an underlying cause.

impl<D: Display + Send + Sync + 'static> Debug for Context<D>

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

Formats the value using the given formatter.

impl<D: Display + Send + Sync + 'static> Display for Context<D>

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

Formats the value using the given formatter.

impl<D> From<D> for Context<D> where
    D: Display + Send + Sync + 'static, 

fn from(display: D) -> Context<D>

Performs the conversion.