Struct Fatal 

pub struct Fatal {
    pub kind: FatalKind,
    pub context: Option<Cow<'static, str>>,
    /* private fields */
}

A failure that will not succeed on retry: a bug, a misconfiguration, or corrupt state.

kind, context and source are for operators (traces, logs) and for tests (which may downcast_ref the source to assert what happened). Production code never inspects a Fatal’s payload: the response to a Fatal is the same regardless of its source — stop, surface, page. If you find yourself needing the payload, the outcome was a value or a Rejection and the API should be changed, not the call site.

Fields

kind: FatalKind

context: Option<Cow<'static, str>>

Implementations

impl Fatal

pub fn new(kind: FatalKind) -> Fatal

pub fn from_error( kind: FatalKind, e: impl Error + Send + Sync + 'static, ) -> Fatal

Fatal::new plus Fatal::with_source, as one call — the common shape at a classification site that has the error in hand.

pub fn with_source(self, e: impl Error + Send + Sync + 'static) -> Fatal

As Transient::with_source. Takes self so a Fatal built from a lane table can be given its source afterwards.

pub fn from_boxed(kind: FatalKind, e: Box<dyn Error + Send + Sync>) -> Fatal

Explicit escape hatch for a source that only arrives boxed. There is no From<Box<dyn Error>> — a caller must say out loud that it is discarding whatever lane the boxed error might have carried.

pub fn from_dyn(kind: FatalKind, e: &(dyn Error + 'static)) -> Fatal

Fatal::new(kind) with the error’s whole Display chain as context — the by-reference form for a boundary holding a &dyn Error it cannot keep as source. The same fold Fault::classify makes in its rule 3, with the kind chosen by the caller.

pub fn invariant(msg: impl Into<Cow<'static, str>>) -> Fatal

pub fn with_context(self, c: impl Into<Cow<'static, str>>) -> Fatal

Trait Implementations

impl Clone for Fatal

fn clone(&self) -> Fatal

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Fatal

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

Formats the value using the given formatter.

impl Display for Fatal

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

Formats the value using the given formatter.

impl Error for Fatal

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 From<!> for Fatal

fn from(value: !) -> Fatal

Converts to this type from the input type.

impl<L> From<Fatal> for Fault<L>

where L: LaneProfile<Fatal = Fatal> + LaneProfile,

fn from(f: Fatal) -> Fault<L>

Converts to this type from the input type.

impl<D, L> From<Fatal> for Fail<D, L>

where L: LaneProfile<Fatal = Fatal> + LaneProfile,

fn from(f: Fatal) -> Fail<D, L>

Converts to this type from the input type.

impl<W> From<W> for Fatal

where W: Classify<Rejected = !, Lanes = Profile<false, false, true>>,

A wrapper that only ever ends in the fatal lane converts into that bare payload directly, so -> Result<T, Fatal> is a legal, narrowest signature for a fault-only wrapper.

fn from(w: W) -> Fatal

Converts to this type from the input type.