Struct DomainError

pub struct DomainError {
    pub output: ExitError,
    pub source: Option<Box<dyn StdError + Send + Sync>>,
}

Wrapper for errors that are not a Fault. It is used as the explicit_error::Error::Domain variant generic type.

It is highly recommended to implement the derive ExitError which generates the boilerplate for your domain errors. Otherwise you can implement the ToDomainError trait.

Error implements From<DomainError>, use ? and .into() in functions and closures to convert to the Error::Domain variant.

Examples

DomainError can be generated because of a predicate

use explicit_error_exit::{prelude::*, ExitError, Result, derive::ExitError};
use std::process::ExitCode;

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

impl From<&MyError> for ExitError {
    fn from(value: &MyError) -> Self {
        match value {
            MyError::Foo => ExitError::new(
                    "Something went wrong because ..",
                    ExitCode::from(42)
                ),
        }
    }
}

fn business_logic() -> Result<()> {
    if 1 < 2 {
        Err(MyError::Foo)
            .with_context("Usefull context to debug or monitor")?;
    }
}

Or from a Result

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


fn business_logic() -> Result<()> {   
   Err(ErrorKind::Foo).map_err_or_fault(|e|
        match e {
            ErrorKind::Foo => Ok(MyError::Foo),
            _ => Err(e)
        }
    )?;
}

Or an Option

Some(12).ok_or(ExitError::new("Something went wrong because ..", ExitCode::from(42)))?;

Fields

output: ExitError

source: Option<Box<dyn StdError + Send + Sync>>

Trait Implementations

impl Debug for DomainError

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

Formats the value using the given formatter.

impl Display for DomainError

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

Formats the value using the given formatter.

impl Domain for DomainError

fn into_source(self) -> Option<Box<dyn Error + Send + Sync>>

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

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

impl Error for DomainError

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 From<DomainError> for Error<DomainError>

fn from(value: DomainError) -> Self

Converts to this type from the input type.

impl From<DomainError> for MainError

fn from(value: DomainError) -> Self

Converts to this type from the input type.