Struct Fault

pub struct Fault {
    pub source: Option<Box<dyn Error + Sync + Send>>,
    /* private fields */
}

Re-import from explicit_error crate. Wrapper for errors that should not happen but cannot panic. It is wrapped in the Error::Fault variant.

To generate it from predicates use Fault::new, from Result or Option import the prelude and use either or_fault(), or_fault_no_source(), or_fault_force(), or_fault_no_source_force(), ok_or_fault() ok_or_fault_force()

Fields

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

Implementations

impl Fault

pub fn new() -> Fault

Usefull to generate a Fault when a predicate is not met.

Examples

if 1 < 2 {
    Err(Fault::new())?;
}

pub fn with_source<E>(self, error: E) -> Fault

where E: Error + 'static + Send + Sync,

Add an error source to a Fault. Usefull to generate a fault when pattern matching on an error type.

On a Result use map_err_or_fault to be more concise.

Examples

fn fetch() -> Result<()> {
    let sqlx_error = sqlx::Error::RowNotFound;
    Err(match sqlx_error {
        sqlx::Error::RowNotFound => MyEntitysError::NotFound.into(),
        _ => Fault::new().with_source(sqlx_error).into()
    })
}

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

Add context to a Fault, override if one was set. The context appears in display but not in the http response.

Examples

if 1 < 2 {
    Err(Fault::new().with_context("Some info to help debug"))?;
}

pub fn new_force() -> Fault

Force backtrace capture using force_capture

Examples

if 1 < 2 {
    Err(Fault::new_force())?;
}

pub fn backtrace_status(&self) -> BacktraceStatus

Return the status of the backtrace

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

Return the context

Trait Implementations

impl Debug for Fault

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

Formats the value using the given formatter.

impl Default for Fault

fn default() -> Fault

Returns the “default value” for a type.

impl Display for Fault

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

Formats the value using the given formatter.

impl Error for Fault

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

Converts to this type from the input type.

impl Serialize for Fault

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.