Enum Diagnostic 

#[non_exhaustive]
pub enum Diagnostic {
    SourceContainsPua {
        at: SourceSpan,
        codepoint: char,
        span: Span,
    },
    UnclosedBracket {
        at: SourceSpan,
        kind: PairKind,
        span: Span,
    },
    UnmatchedClose {
        at: SourceSpan,
        kind: PairKind,
        span: Span,
    },
    Internal {
        at: SourceSpan,
        check: InternalCheckCode,
        span: Span,
    },
}

Observation emitted by any lexer phase.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SourceContainsPua

Source contains a codepoint that collides with one of the lexer’s PUA sentinel reservations (crate::INLINE_SENTINEL, crate::BLOCK_LEAF_SENTINEL, crate::BLOCK_OPEN_SENTINEL, crate::BLOCK_CLOSE_SENTINEL). Downstream phases will emit those same codepoints into normalized text, so a collision means the placeholder registry can no longer distinguish source-text occurrences from lexer-inserted markers.

Fields

at: SourceSpan

codepoint: char

span: Span

Byte-range in the original source for programmatic consumers that don’t need miette’s [miette::SourceSpan].

UnclosedBracket

An open delimiter reached end-of-input with no matching close on the pairing stack.

Fields

at: SourceSpan

kind: PairKind

span: Span

Byte-range of the unmatched open delimiter in the sanitized source.

UnmatchedClose

A close delimiter was seen with an empty stack, or with a stack top of a different [PairKind].

Fields

at: SourceSpan

kind: PairKind

span: Span

Byte-range of the stray close delimiter.

Internal

Pipeline-internal sanity-check failure — production parses on well-formed input never emit this. The check payload identifies the specific check via the typed [InternalCheckCode] enum; tooling that prefers the stable string identifier reaches via Self::code. Library consumers that just want to filter “library bugs” out of the stream check source instead.

Fields

at: SourceSpan

check: InternalCheckCode

Typed identifier for the specific check that fired. Pin per-check assertions on this rather than the stringly-typed code accessor so the compiler enforces match exhaustiveness at the call site.

span: Span

Byte-range covering the violation site.

Implementations

impl Diagnostic

pub fn source_contains_pua(at: Span, codepoint: char) -> Diagnostic

Constructor for Diagnostic::SourceContainsPua.

pub fn unclosed_bracket(at: Span, kind: PairKind) -> Diagnostic

Constructor for Diagnostic::UnclosedBracket.

pub fn unmatched_close(at: Span, kind: PairKind) -> Diagnostic

Constructor for Diagnostic::UnmatchedClose.

pub fn internal(at: Span, check: InternalCheckCode) -> Diagnostic

Constructor for Diagnostic::Internal. Takes a typed [InternalCheckCode] — the compiler enforces that every production emit-site classifies the check correctly.

pub fn severity(&self) -> Severity

Severity routing axis. See Severity.

#[non_exhaustive] puts the responsibility on every match here for adding-new-variant time, not on a catch-all arm — the compiler will refuse to build until the new variant is classified.

pub fn source(&self) -> DiagnosticSource

Origin axis: user input vs. pipeline-internal. See DiagnosticSource.

pub fn span(&self) -> Span

Byte-range covering the diagnostic.

pub fn code(&self) -> &'static str

Stable string identifier for this diagnostic. Returns one of the constants from [codes] for production variants, or the Internal payload’s [InternalCheckCode::as_code] for pipeline-internal checks.

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Diagnostic

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

Formats the value using the given formatter.

impl Diagnostic for Diagnostic

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 severity(&self) -> Option<Severity>

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

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

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

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 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 Diagnostic

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

Formats the value using the given formatter.

impl Error for Diagnostic

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.