Skip to main content

BoxedStackError

Struct BoxedStackError 

Source
pub struct BoxedStackError { /* private fields */ }
Expand description

Type-erased wrapper around Box<dyn StackError + Send + Sync>.

Provides uniform handling of heterogeneous StackError types while preserving location tracking through the error chain. Use this instead of Box<dyn StackError + Send + Sync> for shorter type signatures and automatic From generation by the derive macro.

Note: downcasting to the concrete type is not supported through this wrapper. Use into_inner() if you need the raw trait object.

Clone is not implemented because the inner trait object (Box<dyn StackError + Send + Sync>) cannot be cloned.

§Example

use suzunari_error::*;

#[suzunari_error]
#[suzu(display("inner error"))]
struct InnerError {}

#[suzunari_error]
#[suzu(display("outer error"))]
struct OuterError {
    source: BoxedStackError,
}

fn inner() -> Result<(), InnerError> {
    ensure!(false, InnerSnafu);
    Ok(())
}

fn outer() -> Result<(), OuterError> {
    inner()
        .map_err(BoxedStackError::new)
        .context(OuterSnafu)?;
    Ok(())
}

let err = outer().unwrap_err();
assert_eq!(err.type_name(), "OuterError");
assert!(err.stack_source().is_some());

Implementations§

Source§

impl BoxedStackError

Source

pub fn new<T: StackError + Send + Sync + 'static>(inner: T) -> Self

Wraps a concrete StackError in a type-erased box.

Source

pub fn inner(&self) -> &(dyn StackError + Send + Sync)

Returns a reference to the inner trait object.

Source

pub fn into_inner(self) -> Box<dyn StackError + Send + Sync>

Unwraps into the inner trait object.

Trait Implementations§

Source§

impl Debug for BoxedStackError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for BoxedStackError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for BoxedStackError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

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. Read more
Source§

impl From<Box<dyn StackError + Sync + Send>> for BoxedStackError

Source§

fn from(inner: Box<dyn StackError + Send + Sync>) -> Self

Converts to this type from the input type.
Source§

impl From<BoxedStackError> for Box<dyn StackError + Send + Sync>

Source§

fn from(inner: BoxedStackError) -> Self

Converts to this type from the input type.
Source§

impl StackError for BoxedStackError

Source§

fn location(&self) -> Location

Returns the location where this error was constructed.
Source§

fn type_name(&self) -> &'static str

Returns a human-readable type name for display in stack traces. Read more
Source§

fn stack_source(&self) -> Option<&dyn StackError>

Returns the source error as a StackError, if available. Read more
Source§

fn depth(&self) -> usize

Returns the number of errors in the Error::source() chain (excluding self). Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsErrorSource for T
where T: Error + 'static,

Source§

fn as_error_source(&self) -> &(dyn Error + 'static)

For maximum effectiveness, this needs to be called as a method to benefit from Rust’s automatic dereferencing of method receivers.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.