Struct Report

pub struct Report<E>
where
    E: ReportableError,
{ /* private fields */ }

A report with additional debugging info for an error.

A Report<E> can be used to identify exactly where the error E occurred in mediasan. The Debug implementation will print a human-readable parser stack trace. The underlying error of type E can also be retrieved e.g. for matching against with get_ref or into_inner.

Implementations

impl<E> Report<E>

where E: ReportableError,

pub fn get_ref(&self) -> &E

Get a reference to the underlying error.

pub fn into_inner(self) -> E

Unwrap this report, returning the underlying error.

pub fn attach_printable<P>(self, message: P) -> Report<E>

where P: Display + Send + Sync + 'static,

Attach a Display-able type to the stack trace.

Trait Implementations

impl<E> Debug for Report<E>

where E: ReportableError,

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

Formats the value using the given formatter.

impl<E> Display for Report<E>

where E: ReportableError + Display,

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

Formats the value using the given formatter.

impl<E> Error for Report<E>

where E: ReportableError + Error + 'static, Report<E>: Debug + Display,

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<E> From<E> for Report<E>

where E: ReportableError,

fn from(error: E) -> Report<E>

Converts to this type from the input type.

impl<E> From<Report<E>> for Error<E>

where E: ReportableError,

fn from(source: Report<E>) -> Error<E>

Converts to this type from the input type.