Trait IntoReport

Source

pub trait IntoReport {
    type Context: ?Sized;

    // Required method
    fn into_report(self) -> Report<Self::Context>;
}

Expand description

Provides unified way to convert an error-like structure to a Report.

This trait allows both Report<C> instances and regular error types to be converted into a Report. It is automatically implemented for any type that can be converted into a Report via the Into trait.

This trait is particularly useful when working with functions that need to return a Report, as it provides a consistent way to convert errors into reports without explicitly calling conversion methods.

§Examples

use std::io;

use error_stack::{IntoReport as _, Report};

fn example() -> Result<(), Report<io::Error>> {
    // io::Error implements Into<Report<io::Error>>, so we can use into_report()
    let err = io::Error::new(io::ErrorKind::Other, "oh no!");
    Err(err.into_report())
}