Struct Failure 

pub struct Failure<E> { /* private fields */ }

An error with diagnostics captured where it is wrapped, which can be retained and reported later.

Capture at the failure boundary to preserve its origin before returning the value across async tasks. Backtrace::capture honours RUST_BACKTRACE and RUST_LIB_BACKTRACE; a supplied backtrace may instead be passed to Self::with_backtrace. Span traces require the error layer included by crate::Console::layer.

Implementations

impl<E> Failure<E>

pub fn capture(error: E) -> Self

Capture the current backtrace, when enabled, and logical span context.

pub fn with_backtrace(error: E, backtrace: Backtrace) -> Self

Retain a previously captured backtrace and capture the current span context.

pub fn error(&self) -> &E

The underlying error.

pub fn backtrace(&self) -> &Backtrace

The captured or supplied OS stack backtrace.

pub fn span_trace(&self) -> Option<&str>

A text snapshot of the logical span context at capture time, if available.

pub fn into_inner(self) -> E

Recover the underlying error, discarding the captured diagnostics.

impl<E> Failure<E>

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

The backtrace when capture succeeded; disabled or unsupported traces are omitted.

Trait Implementations

impl<E: Debug> Debug for Failure<E>

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

Formats the value using the given formatter.

impl<E: Display> Display for Failure<E>

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

Formats the value using the given formatter.

impl<E: Error + 'static> Error for Failure<E>

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.