Trait miette::Diagnostic

pub trait Diagnostic: Error {
    fn code<'a>(&'a self) -> Box<dyn Display + 'a>;

    fn severity(&self) -> Option<Severity> { ... }
    fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>> { ... }
    fn snippets(
        &self
    ) -> Option<Box<dyn Iterator<Item = DiagnosticSnippet<'_>>>> { ... }
}

Adds rich metadata to your Error that can be used by DiagnosticReportPrinter to print really nice and human-friendly error messages.

Required methods

fn code<'a>(&'a self) -> Box<dyn Display + 'a>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or Enums will work just fine.

Provided methods

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by DiagnosticReportPrinters to change the display format of this diagnostic.

If None, reporters should treat this as Severity::Error

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn snippets(&self) -> Option<Box<dyn Iterator<Item = DiagnosticSnippet<'_>>>>

Additional contextual snippets. This is typically used for adding marked-up source file output the way compilers often do.

Implementors

impl Diagnostic for DiagnosticError