Trait ReportHandler

source

pub trait ReportHandler:
    Any
    + Send
    + Sync {
    // Required method
    fn debug(&self, error: &dyn Diagnostic, f: &mut Formatter<'_>) -> Result;

    // Provided methods
    fn display(
        &self,
        error: &(dyn StdError + 'static),
        f: &mut Formatter<'_>,
    ) -> Result { ... }
    fn track_caller(&mut self, location: &'static Location<'static>) { ... }
}

Expand description

Error Report Handler trait for customizing miette::Report

Required Methods§

source

fn debug(&self, error: &dyn Diagnostic, f: &mut Formatter<'_>) -> Result

Define the report format

Used to override the report format of miette::Report

§Example

use indenter::indented;
use miette::{Diagnostic, ReportHandler};

pub struct Handler;

impl ReportHandler for Handler {
    fn debug(
        &self,
        error: &dyn Diagnostic,
        f: &mut core::fmt::Formatter<'_>,
    ) -> core::fmt::Result {
        use core::fmt::Write as _;

        if f.alternate() {
            return core::fmt::Debug::fmt(error, f);
        }

        write!(f, "{}", error)?;

        Ok(())
    }
}