Type Alias Error

pub type Error = StackedError;

Aliased Type

pub struct Error { /* private fields */ }

Implementations

impl Error

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

Trait Implementations

impl Debug for Error

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

Has terminal styling

impl Default for Error

fn default() -> Self

Returns the “default value” for a type.

impl Display for Error

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

Same as Debug but without terminal styling

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<'a> IntoIterator for &'a Error

type IntoIter = Iter<'a, ErrorItem>

Which kind of iterator are we turning this into?

type Item = &'a ErrorItem

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Error

type IntoIter = IterMut<'a, ErrorItem>

Which kind of iterator are we turning this into?

type Item = &'a mut ErrorItem

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl StackableErr for Error

type Output = Result<(), StackedError>

fn stack(self) -> Self::Output

Pushes just location information to the error stack

fn stack_locationless(self) -> Self::Output

Only converts to Self::Output and pushes it on the error stack

fn stack_err<E1: Display + Send + Sync + 'static>(self, e: E1) -> Self::Output

Pushes the result of f and location information to the error stack

fn stack_err_with<E1: Display + Send + Sync + 'static, F: FnOnce() -> E1>( self, f: F, ) -> Self::Output

Pushes e and location information to the error stack

fn stack_err_locationless<E1: Display + Send + Sync + 'static>( self, e: E1, ) -> Self::Output

Pushes e without location information to the error stack

fn stack_err_with_locationless<E1: Display + Send + Sync + 'static, F: FnOnce() -> E1>( self, f: F, ) -> Self::Output

Pushes the result of f without location information to the error stack

fn wrap_err<D: Display + Send + Sync + 'static>(self, msg: D) -> Self::Output

Alternate for StackableErr::stack_err which can be used for easier translation to and from the eyre crate

fn wrap_err_with<D: Display + Send + Sync + 'static, F: FnOnce() -> D>( self, msg: F, ) -> Self::Output

Alternate for StackableErr::stack_err_with which can be used for easier translation to and from the eyre crate

fn context<D: Display + Send + Sync + 'static>(self, msg: D) -> Self::Output

Alternate for StackableErr::stack_err which can be used for easier translation to and from the anyhow crate

fn with_context<D: Display + Send + Sync + 'static, F: FnOnce() -> D>( self, msg: F, ) -> Self::Output

Alternate for StackableErr::stack_err_with which can be used for easier translation to and from the anyhow crate