Struct ValidationDiagnostic 

pub struct ValidationDiagnostic {
    pub error: ValidationError,
    pub src: Option<NamedSource<String>>,
    pub span: Option<SourceSpan>,
}

Diagnostic wrapper that attaches an optional source code snippet and a best-effort byte range to a ValidationError for fancy rendering via miette. The wrapper delegates help() and code() to the inner error while exposing its own source_code and labels so the renderer can underline the offending identifier in the input.

Fields

error: ValidationError

src: Option<NamedSource<String>>

span: Option<SourceSpan>

Implementations

impl ValidationDiagnostic

pub fn new(error: ValidationError, source: Option<(&str, &str)>) -> Self

Build a ValidationDiagnostic from a ValidationError and an optional (filename, contents) source. When a source is provided the constructor performs a best-effort search for the offending identifier (e.g. a duplicate module name or unknown type reference) and attaches a SourceSpan for fancy rendering. If no span can be computed the label is omitted and miette still produces a nicer message + help section than plain Display.

Trait Implementations

impl Debug for ValidationDiagnostic

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Diagnostic for ValidationDiagnostic

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.

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.

impl Display for ValidationDiagnostic

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ValidationDiagnostic

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.