Struct StackedError 

pub struct StackedError { /* private fields */ }

An error struct intended for high level error propogation with programmable backtraces

For lower level error propogation, you should still use ordinary Option and Result with domain-specific enums, it is only when using OS-level functions or when multiple domains converge that this is intended to be used. This has an internal stack for different kinds of arbitrary errors and Locations. When used with the StackableErr trait, this enables easy conversion and software defined backtraces for better async debugging. See the crate docs for more.

Implementations

impl StackedError

Note: in most cases you can use Error::from or a call from StackableErr instead of these functions.

pub fn empty() -> Self

Returns an empty error stack

pub fn new() -> Self

Returns an error stack with just a UnitError and location information

pub fn from_err<E: Display + Send + Sync + 'static>(e: E) -> Self

pub fn from_err_locationless<E: Display + Send + Sync + 'static>(e: E) -> Self

pub fn push(&mut self)

Only pushes track_caller location to the stack

pub fn add(self) -> Self

Only adds track_caller location to the stack

pub fn push_err<E: Display + Send + Sync + 'static>(&mut self, e: E)

Pushes error e with location to the stack

pub fn add_err<E: Display + Send + Sync + 'static>(self, e: E) -> Self

Adds error e with location to the stack

pub fn push_err_locationless<E: Display + Send + Sync + 'static>( &mut self, e: E, )

Pushes error e without location information to the stack

pub fn add_err_locationless<E: Display + Send + Sync + 'static>( self, e: E, ) -> Self

Adds error e without location information to the stack

pub fn chain_errors(self, other: Self) -> Self

Moves the stack of other onto self

pub fn timeout() -> Self

Returns a base TimeoutError error

pub fn probably_not_root_cause() -> Self

Returns a base ProbablyNotRootCauseError error

pub fn is_timeout(&self) -> bool

Returns if a TimeoutError is in the error stack

pub fn is_probably_not_root_cause(&self) -> bool

Returns if a ProbablyNotRootCauseError is in the error stack

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

Iteration over the StackedErrorDowncast items of self

pub fn iter_mut(&mut self) -> IterMut<'_, ErrorItem>

Mutable iteration over the StackedErrorDowncast items of self