Struct StructuredError 

pub struct StructuredError { /* private fields */ }

Type-erased error with chained sources, attachments, and diagnostic rendering.

Implementations

impl StructuredError

pub fn new<T: StdError + Send + Sync + 'static>(context: T) -> Self

Create from any error, capturing its diagnostic code before type erasure.

pub fn change_context<T: StdError + Send + Sync + 'static>( self, new_context: T, ) -> StructuredError

Wrap this error as the source of a new context.

pub fn current_context(&self) -> &(dyn StdError + Send + Sync + 'static)

Get the current context.

Trait Implementations

impl Attach for StructuredError

fn attach(self, name: impl Into<String>, value: impl Display) -> Self

Attach a name and value.

fn attach_with<D: Display>( self, name: impl Into<String>, value: impl FnOnce() -> D, ) -> Self

Attach a name and lazily evaluated value.

fn attach_path(self, path: impl AsRef<Path>) -> Self

Attach a Path.

impl Debug for StructuredError

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

Formats the value using the given formatter.

impl Diagnostic for StructuredError

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for StructuredError

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

Formats the value using the given formatter.

impl Error for StructuredError

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<T: StdError + Send + Sync + 'static> From<Report<T>> for StructuredError

fn from(report: Report<T>) -> Self

Converts to this type from the input type.