Trait miette::Diagnostic

pub trait Diagnostic: Error {
    fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>> { ... }
    fn severity(&self) -> Option<Severity> { ... }
    fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>> { ... }
    fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>> { ... }
    fn source_code(&self) -> Option<&dyn SourceCode> { ... }
    fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>> { ... }
    fn related<'a>(
        &'a self
    ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>> { ... }
    fn diagnostic_source(&self) -> Option<&dyn Diagnostic> { ... }
}

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

Provided Methods

fn code<'a>(&'a self) -> Option<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.

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

Diagnostic severity. This may be used by ReportHandlers 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 url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>(
    &'a self
) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

Trait Implementations

impl AsRef<dyn Diagnostic + 'static> for Report

fn as_ref(&self) -> &(dyn Diagnostic + 'static)

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<dyn Diagnostic + Send + Sync + 'static> for Report

fn as_ref(&self) -> &(dyn Diagnostic + Send + Sync + 'static)

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<dyn Diagnostic + 'static> for Report

fn borrow(&self) -> &(dyn Diagnostic + 'static)

Immutably borrows from an owned value.

impl Error for Box<dyn Diagnostic>

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn provide(&'a self, demand: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl<'a> From<&str> for Box<dyn Diagnostic + Send + Sync + 'a>

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<&str> for Box<dyn Diagnostic>

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Box<dyn Error + Send + Sync + 'static, Global>> for Box<dyn Diagnostic + Send + Sync>

fn from(s: Box<dyn Error + Send + Sync>) -> Self

Converts to this type from the input type.

impl From<Report> for Box<dyn Diagnostic + 'static>

fn from(error: Report) -> Self

Converts to this type from the input type.

impl From<Report> for Box<dyn Diagnostic + Send + Sync + 'static>

fn from(error: Report) -> Self

Converts to this type from the input type.

impl From<String> for Box<dyn Diagnostic + Send + Sync>

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<String> for Box<dyn Diagnostic>

fn from(s: String) -> Self

Converts to this type from the input type.

impl<T: Diagnostic + Send + Sync + 'static> From<T> for Box<dyn Diagnostic + 'static>

fn from(diag: T) -> Self

Converts to this type from the input type.

impl<T: Diagnostic + Send + Sync + 'static> From<T> for Box<dyn Diagnostic + Send + 'static>

fn from(diag: T) -> Self

Converts to this type from the input type.

impl<T: Diagnostic + Send + Sync + 'static> From<T> for Box<dyn Diagnostic + Send + Sync + 'static>

fn from(diag: T) -> Self

Converts to this type from the input type.

Implementors

impl Diagnostic for MietteError

impl Diagnostic for InstallError