Trait ErrorType 

pub trait ErrorType: Error {
    type Span: Span;
    type Message: Display;

    // Required methods
    fn kind(&self) -> Kind;
    fn number(&self) -> &str;
    fn code(&self) -> &str;
    fn primary_span(&self) -> Self::Span;
    fn primary_message(&self) -> Self::Message;
    fn primary_label(&self) -> Self::Message;

    // Provided methods
    fn fmt_as_annotate_snippets(&self) -> Result<String, Error> { ... }
    fn fmt_as_annotate_snippets_with_opts(
        &self,
        opts: FormatOptions,
    ) -> Result<String, Error> { ... }
    fn fmt_as_ariadne_report(&self) -> Result<String, Error> { ... }
    fn fmt_as_ariadne_report_with(
        &self,
        config: Config,
    ) -> Result<String, Error> { ... }
    fn as_codespan_diagnostic(
        &self,
    ) -> (Diagnostic<usize>, SimpleFiles<<Self::Span as Span>::Uri, <Self::Span as Span>::Source>) { ... }
    fn fmt_as_codespan_diagnostic_with(
        &self,
        config: Config,
        styles: Option<&Styles>,
    ) -> Result<String, Error> { ... }
    fn as_miette_diagnostic(&self) -> impl Diagnostic
       where Self::Span: Send + Sync { ... }
    fn fmt_as_miette_diagnostic_with(
        &self,
        handler: &impl ReportHandler,
    ) -> String
       where Self: Sized + 'static,
             Self::Span: Send + Sync { ... }
}

Trait for error types generated by error_type! macro and ErrorType derive macro.

Required Associated Types

type Span: Span

The span type associated with the error type.

type Message: Display

The message type associated with the error type.

Required Methods

fn kind(&self) -> Kind

Get the kind of the error.

fn number(&self) -> &str

Get the number of the error.

fn code(&self) -> &str

Get the code of the error.

Normally the code is a combination of kind short string and number, like “E0”, “W1”, etc.

fn primary_span(&self) -> Self::Span

Get the primary span of the error.

fn primary_message(&self) -> Self::Message

Get the primary message of the error.

fn primary_label(&self) -> Self::Message

Get the primary label of the error.

Provided Methods

fn fmt_as_annotate_snippets(&self) -> Result<String, Error>

Format the error as an annotate snippet.

fn fmt_as_annotate_snippets_with_opts( &self, opts: FormatOptions, ) -> Result<String, Error>

Format the error as an annotate snippet with format options.

fn fmt_as_ariadne_report(&self) -> Result<String, Error>

Format the error as an Ariadne report.

fn fmt_as_ariadne_report_with(&self, config: Config) -> Result<String, Error>

Format the error as an Ariadne report with Ariadne config.

fn as_codespan_diagnostic( &self, ) -> (Diagnostic<usize>, SimpleFiles<<Self::Span as Span>::Uri, <Self::Span as Span>::Source>)

Format the error as an Codespan diagnostic.

fn fmt_as_codespan_diagnostic_with( &self, config: Config, styles: Option<&Styles>, ) -> Result<String, Error>

Format the error as an Codespan diagnostic with Codespan config.

fn as_miette_diagnostic(&self) -> impl Diagnostic

where Self::Span: Send + Sync,

Convert the error to a Miette diagnostic.

fn fmt_as_miette_diagnostic_with(&self, handler: &impl ReportHandler) -> String

where Self: Sized + 'static, Self::Span: Send + Sync,

Format the error as a Miette diagnostic with a Miette handler.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T> ErrorType for &T

where T: ErrorType + ?Sized,

type Span = <T as ErrorType>::Span

type Message = <T as ErrorType>::Message

fn kind(&self) -> Kind

fn number(&self) -> &str

fn code(&self) -> &str

fn primary_span(&self) -> <&T as ErrorType>::Span

fn primary_message(&self) -> <&T as ErrorType>::Message

fn primary_label(&self) -> <&T as ErrorType>::Message

fn fmt_as_annotate_snippets(&self) -> Result<String, Error>

fn fmt_as_annotate_snippets_with_opts( &self, opts: FormatOptions, ) -> Result<String, Error>

fn fmt_as_ariadne_report(&self) -> Result<String, Error>

fn fmt_as_ariadne_report_with(&self, config: Config) -> Result<String, Error>

fn as_codespan_diagnostic( &self, ) -> (Diagnostic<usize>, SimpleFiles<<<&T as ErrorType>::Span as Span>::Uri, <<&T as ErrorType>::Span as Span>::Source>)

fn fmt_as_codespan_diagnostic_with( &self, config: Config, styles: Option<&Styles>, ) -> Result<String, Error>

fn as_miette_diagnostic(&self) -> impl Diagnostic

where <&T as ErrorType>::Span: Send + Sync,

Implementors