Struct Report

pub struct Report<E: AsRefError>(/* private fields */);

Report prints an error and all its sources.

Source messages will be cleaned using CleanedErrors to remove duplication from errors that include their source’s message in their own message.

The debug implementation prints each error on a separate line, while the display implementation prints all errors on one line separated by a colon. Using alternate formatting ({:#}) is identical to the debug implementation.

The debug implementation is intended for cases where errors are debug printed, for example returning an error from main or using expect on Result:

use error_report::Report;

fn func1() -> Result<(), std::io::Error> {
    Err(std::io::Error::other("oh no!"))
}

fn main() -> Result<(), Report<impl std::error::Error>> {
    func1()?;
    Ok(())
}

let i: i8 = 256.try_into().map_err(Report::from).expect("conversion error");

Implementations

impl<E: AsRefError> Report<E>

pub fn new(err: E) -> Self

Construct a new Report from an error.

impl<E: AsRef<dyn Error>> Report<Ref<E>>

pub fn from_ref(value: E) -> Self

Construct a new Report from a type that implements AsRef<dyn Error>.

Trait Implementations

impl<E: AsRefError> Debug for Report<E>

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

Formats the value using the given formatter.

impl<E: AsRefError> Display for Report<E>

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

Formats the value using the given formatter.

impl<E: AsRefError> From<E> for Report<E>

fn from(value: E) -> Self

Converts to this type from the input type.

impl<E: AsRef<dyn Error>> From<E> for Report<Ref<E>>

fn from(value: E) -> Self

Converts to this type from the input type.