Struct ExitError

Source

pub struct ExitError {
    pub message: String,
    pub exit_code: ExitCode,
    pub context: Option<String>,
}

Expand description

Representation of errors that ends a process/program.

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

Note: ExitError convert to Error by converting first to DomainError.

§Examples

Domain errors that derive ExitError must implement From<#MyDomainError> for ExitError.

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)
                ),
        }
    }
}

Domain errors cannot require to be extracted in either a struct or enum variant. You can generate Error::Domain variant with an ExitError

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

fn business_logic() -> Result<()> {

    Err(42).map_err(|e|
        ExitError::new(
            "Something went wrong because ..",
            ExitCode::from(e)
        )
    )?;

    Ok(())
}

Fields§

§message: String§exit_code: ExitCode§context: Option<String>

Implementations§

Source §

impl ExitError

Source

pub fn new(message: impl Display, exit_code: ExitCode) -> Self

Generate an ExitError without a context. To add a context use with_context afterwards.

§Examples

use explicit_error_exit::ExitError;
use std::process::ExitCode;

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

Source

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

Add a context to an ExitError, override if one was set. The context appears in display but not in the Display implementation.

§Examples

use explicit_error_exit::ExitError;
use std::process::ExitCode;

ExitError::new(
    "Something went wrong because ..",
    ExitCode::from(42)
).with_context("The reason why it went wrong");