Struct ErasedError 

#[non_exhaustive]
pub struct ErasedError { /* private fields */ }

A serializable, cloneable error representation that preserves the full error context including backtrace, spantrace, and source chain.

This type is designed for API error responses where the original error cannot be directly serialized. Construct one with from_error or from_error_ref, or by deserializing a transported payload; read its contents through the accessor methods.

The captured backtrace, span trace, and caller location are exposed via backtrace, spantrace, and location as ErasedBacktrace / ErasedSpanTrace / ErasedLocation snapshots. They are not surfaced through the Diagnostic impl: those accessors return references to live Backtrace/SpanTrace values and a &'static Location, which a transported snapshot cannot reconstruct. Re-erasing an ErasedError (via from_error_ref) preserves the message, source chain, code, help, and exit code, but the trace and location snapshots stay reachable only through this type’s own accessors.

Implementations

impl ErasedError

pub fn from_error<E: Diagnostic>(err: E) -> Self

Create an ErasedError from any error implementing Diagnostic.

This extracts the message, source chain, backtrace, spantrace, error code, and help text via the Diagnostic trait.

pub fn from_error_ref<E: Diagnostic>(err: &E) -> Self

Create an ErasedError from a reference to any error implementing Diagnostic.

Like from_error but takes a reference, useful when ownership cannot be transferred (e.g., in Serialize implementations).

pub fn message(&self) -> &str

The primary error message (the original error’s Display).

pub fn source_chain(&self) -> &[Box<str>]

The Display of each transported cause, outermost first.

pub const fn diagnostics(&self) -> &Diagnostics

The transported diagnostic metadata (error code and help text).

pub const fn location(&self) -> Option<&ErasedLocation>

The captured caller-location snapshot, if one was transported.

pub const fn spantrace(&self) -> Option<&ErasedSpanTrace>

The captured span trace snapshot, if one was transported.

pub const fn backtrace(&self) -> Option<&ErasedBacktrace>

The captured backtrace snapshot, if one was transported.

pub fn write_json<W: Write>(&self, f: &mut W) -> Result<(), Error>

Serialize the error as pretty-printed JSON to a writer.

Errors

Returns the serialization error, including any underlying I/O failure from the writer.

pub fn write_text<W: Write>(&self, f: &mut W) -> Result<()>

Write the error in a text format similar to Report.

pub fn to_text(&self) -> String

The full multi-line text report (header, source chain, help, traces) as a String. Display intentionally prints only the message so an ErasedError embeds cleanly in another error’s source chain.

pub fn format_short(&self) -> String

Format the error as a short string without backtrace or spantrace.

Trait Implementations

impl Clone for ErasedError

fn clone(&self) -> ErasedError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErasedError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErasedError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Diagnostic for ErasedError

fn oopsie_error_code(&self) -> Option<ErrorCode>

Returns the error code associated with this error.

fn oopsie_help_text(&self) -> Option<HelpText>

Returns the help text associated with this error.

fn oopsie_exit_code(&self) -> Option<NonZeroU8>

Returns the process exit code this error should terminate with.

fn oopsie_backtrace(&self) -> Option<&Backtrace>

Returns the backtrace captured when this error was created.

fn oopsie_spantrace(&self) -> Option<&SpanTrace>

Returns the span trace captured when this error was created.

fn oopsie_location(&self) -> Option<&'static Location<'static>>

Returns the caller location captured when this error was created.

impl Display for ErasedError

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

Formats the value using the given formatter.

impl Error for ErasedError

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 Serialize for ErasedError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.