Enum Error

pub enum Error<D> {
    Domain(Box<D>),
    Fault(Fault),
}

Use Result<T, explicit_error::Error> as the return type of any binary crate faillible function returning errors. The Error::Fault variant is for errors that should not happen but cannot panic. The Error::Domain variant is for domain errors that provide feedbacks to the user. For library or functions that require the caller to pattern match on the returned error, a dedicated type is prefered.

Variants

Domain(Box<D>)

Fault(Fault)

Implementations

impl<D> Error<D>

where D: StdError + 'static,

pub fn is_domain(&self) -> bool

Return true if it’s a Error::Domain variant

pub fn is_fault(&self) -> bool

Return true if it’s a Error::Fault variant

pub fn unwrap(self) -> D

Unwrap the Error::Domain variant, panic otherwise

pub fn unwrap_fault(self) -> Fault

Unwrap the Error::Fault variant, panic otherwise

pub fn downcast_source_ref<E>(&self) -> Option<&E>

where E: StdError + 'static,

Try to downcast the source of the type wrapped in either Error::Domain or Error::Fault variant. If it is not set try to downcast the type wrapped. Usefull to assert_eq! in tests

Examples

use explicit_error_exit::{ExitError, derive::ExitError, Error};
#[test]
fn test() {
    assert_eq!(to_test().unwrap_err().downcast_source_ref()::<MyError>().unwrap(), &MyError::Foo);
}

#[derive(ExitError, Debug)]
enum MyError {
    Foo,
}


fn to_test() -> Result<(), Error> {
    Err(MyError::Foo)?;
    Ok(())
}

impl<D> Error<D>

where D: Domain,

pub fn downcast_source<E>( self, ) -> Result<E, Box<dyn Error + Send + Sync + 'static>>

where E: StdError + 'static,

Try to downcast the source of the type wrapped in either Error::Domain or Error::Fault variant. If it is not set try to downcast the type wrapped. Usefull to assert_eq! in tests

Examples

use explicit_error_exit::{ExitError, derive::ExitError, Error};
#[test]
fn test() {
    assert_eq!(to_test().unwrap_err().downcast_source::<MyError>().unwrap(), MyError::Foo);
}

#[derive(ExitError, Debug)]
enum MyError {
    Foo,
}


fn to_test() -> Result<(), Error> {
    Err(MyError::Foo)?;
    Ok(())
}

pub fn with_context(self, context: impl Display) -> Self

Add context of either Error::Domain or Error::Fault variant. Override existing context

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

Return the context of either Error::Domain or Error::Fault variant.

Trait Implementations

impl<D: Debug> Debug for Error<D>

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

Formats the value using the given formatter.

impl<D> Display for Error<D>

where D: StdError,

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

Formats the value using the given formatter.

impl<D> Error for Error<D>

where D: StdError + 'static,

fn source(&self) -> Option<&(dyn StdError + '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<D> From<Fault> for Error<D>

fn from(value: Fault) -> Self

Converts to this type from the input type.