Struct Report

pub struct Report<T: Diagnostic> { /* private fields */ }

An enriched error wrapper which captures the original error and the subject (String or PointerBuf) which caused it, for reporting purposes.

This type serves two roles:

1. [PointerBuf::parse]: Captures the [ParseError] along with the input String.

2. Reporting: Provides enriched reporting capabilities, including (optional) miette integration, for ParseError and associated errors of assign::Assign and resolve::Resolve implementations

Implementations

impl<T: Diagnostic> Report<T>

pub fn subject(&self) -> &<T::Subject as Deref>::Target

The value which caused the error.

pub fn original(&self) -> &T

The error which occurred.

pub fn decompose(self) -> (T, T::Subject)

The original parts of the Report.

pub fn into_original(self) -> T

Consumes the Report and returns the original error T.

Trait Implementations

impl<T: Clone + Diagnostic> Clone for Report<T>

where T::Subject: Clone,

fn clone(&self) -> Report<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Diagnostic> Debug for Report<T>

where T::Subject: Debug,

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

Formats the value using the given formatter.

impl<T: Diagnostic> Deref for Report<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Diagnostic + Display> Display for Report<T>

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

Formats the value using the given formatter.

impl<T> Error for Report<T>

where T: Diagnostic + Debug + Error + 'static, T::Subject: Debug,

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.