Struct stacked_errors::Error

pub struct Error {
    pub stack: ThinVec<(ErrorKind, Option<&'static Location<'static>>)>,
}

An error struct that has an internal stack for different kinds of errors and Locations. This is a replacement for the bad information you get from backtraces within async tasks.

Fields

stack: ThinVec<(ErrorKind, Option<&'static Location<'static>>)>

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: Error + Send + Sync + 'static>(e: E) -> Self

Returns an error stack with a BoxedError around e, and location info.

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

Same as Error::from_err but without location.

pub fn from_kind<K: Into<ErrorKind>>(kind: K) -> Self

Returns an error stack with just kind.

pub fn from_kind_locationless<K: Into<ErrorKind>>(kind: K) -> Self

Same as Error::from_kind but without location.

pub fn from_box(e: Box<dyn Error + Send + Sync>) -> Self

Returns an error stack with just a BoxedErr.

pub fn from_box_locationless(e: Box<dyn Error + Send + Sync>) -> Self

Same as Error::from_box but without location.

pub fn add_kind<K: Into<ErrorKind>>(self, kind: K) -> Self

Adds kind to the error stack alongside location information. Use StackableErr instead of this if anything expensive in creating the error is involved, because stack_err uses a closure analogous to ok_or_else.

pub fn add_kind_locationless<K: Into<ErrorKind>>(self, kind: K) -> Self

Same as Error::add_kind but without location.

pub fn add_location(self) -> Self

Only adds track_caller location 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

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

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

Formats the value using the given formatter.

impl From<&'static str> for Error

fn from(e: &'static str) -> Self

Converts to this type from the input type.

impl From<()> for Error

fn from(e: ()) -> Self

Converts to this type from the input type.

impl From<Box<dyn Error + Send + Sync>> for Error

fn from(e: Box<dyn Error + Send + Sync>) -> Self

Converts to this type from the input type.

impl From<Cow<'static, str>> for Error

fn from(e: Cow<'static, str>) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf16Error> for Error

fn from(e: FromUtf16Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(e: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<ParseFloatError> for Error

fn from(e: ParseFloatError) -> Self

Converts to this type from the input type.

impl From<ParseIntError> for Error

fn from(e: ParseIntError) -> Self

Converts to this type from the input type.

impl From<String> for Error

fn from(e: String) -> Self

Converts to this type from the input type.

impl From<TryFromIntError> for Error

fn from(e: TryFromIntError) -> Self

Converts to this type from the input type.

impl StackableErr for Error

type Output = Result<(), Error>

fn stack_err<K: Into<ErrorKind>, F: FnOnce() -> K>(self, f: F) -> Self::Output

Pushes the result of f and location information to the stack

fn stack_err_locationless<K: Into<ErrorKind>, F: FnOnce() -> K>( self, f: F ) -> Self::Output

Pushes the result of f without location information

fn stack(self) -> Self::Output

Pushes just location information to the stack

fn stack_locationless(self) -> Self::Output

Only converts to Self::Output