Enum LintelDiagnostic 

pub enum LintelDiagnostic {
    Parse {
        src: NamedSource<String>,
        span: SourceSpan,
        message: String,
    },
    Validation {
        src: NamedSource<String>,
        span: SourceSpan,
        schema_span: SourceSpan,
        path: String,
        instance_path: String,
        label: String,
        message: String,
        schema_url: String,
        schema_path: String,
    },
    SchemaMismatch {
        path: String,
        line_number: usize,
        message: String,
    },
    Io {
        path: String,
        message: String,
    },
    SchemaFetch {
        path: String,
        message: String,
    },
    SchemaCompile {
        path: String,
        message: String,
    },
    Format {
        path: String,
        styled_path: String,
        diff: String,
    },
}

A single diagnostic produced during validation, formatting, or parsing.

Variants

Parse

Fields

src: NamedSource<String>

span: SourceSpan

message: String

Validation

Fields

src: NamedSource<String>

span: SourceSpan

schema_span: SourceSpan

path: String

instance_path: String

label: String

message: String

schema_url: String

Schema URI this file was validated against (shown as a clickable link in terminals for remote schemas).

schema_path: String

JSON Schema path that triggered the error (e.g. /properties/jobs/oneOf).

SchemaMismatch

Fields

path: String

line_number: usize

message: String

Io

Fields

path: String

message: String

SchemaFetch

Fields

path: String

message: String

SchemaCompile

Fields

path: String

message: String

Format

Fields

path: String

styled_path: String

diff: String

Implementations

impl LintelDiagnostic

pub fn path(&self) -> &str

File path associated with this error.

pub fn message(&self) -> &str

Human-readable error message.

pub fn offset(&self) -> usize

Byte offset in the source file (for sorting).

Trait Implementations

impl Debug for LintelDiagnostic

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

Formats the value using the given formatter.

impl Diagnostic for LintelDiagnostic

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

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 help(&self) -> Option<Box<dyn Display + '_>>

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

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

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

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

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

fn url(&self) -> Option<Box<dyn Display + '_>>

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

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

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

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 LintelDiagnostic

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

Formats the value using the given formatter.

impl Error for LintelDiagnostic

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.