Enum DiagnosticKind 

pub enum DiagnosticKind {
    MissingFootnoteDefinition,
    UnusedFootnoteDefinition,
    TableInconsistentColumns,
    SchemaValidation(SchemaValidationKind),
    Handler {
        namespace: String,
        code: Option<String>,
    },
    ForbiddenLabelPrefix,
    UnknownLexCanonical,
    UnclosedAnnotation,
    MissingSessionTarget,
    MissingDefinitionTarget,
    MissingAnnotationTarget,
    MissingCitationTarget,
    MalformedUrl,
    MissingFileTarget,
}

Variants

MissingFootnoteDefinition

UnusedFootnoteDefinition

TableInconsistentColumns

SchemaValidation(SchemaValidationKind)

A label invocation failed schema pre-validation before the handler was dispatched. The variant carries which of the pre-validation checks tripped.

Handler

A diagnostic emitted by a registered extension handler. The namespace field is the namespace name (the part before the first ., e.g., "acme" for label "acme.task") — lex-lsp surfaces it as the diagnostic source: "lex:<namespace>" so editors can filter by extension.

code carries the bare leaf the handler supplied (the code field on lex_extension::Diagnostic), not the wire form. The analyser glues on the namespace prefix in DiagnosticKind::code to produce the wire shape per spec §9 (<namespace>.<leaf>, e.g. "acme.foo"; or the per-namespace fallback "acme.diagnostic" when the handler set None). Passing an already-prefixed value here would produce a double-prefixed wire code ("acme.acme.foo") — handlers should supply just the leaf.

Fields

namespace: String

code: Option<String>

ForbiddenLabelPrefix

A label uses the reserved doc.* prefix (forbidden under comms/specs/general.lex §4.1). PR 4 of #584 emits this when permissive-mode parse lets the label flow through; the LSP then offers a quickfix to rewrite to the blessed shortcut (doc.table → table, doc.image → image, etc.).

UnknownLexCanonical

A lex.* literal that doesn’t match any registered canonical in lex_core::lex::builtins::CANONICAL_LABELS. Typically a typo (lex.fooar) or a label authored against a future version of the core schemas.

UnclosedAnnotation

A paragraph line that looks like an annotation header (:: label) but has no closing ::. There is no “open form” — such a line is kept as paragraph text rather than dropped (lex#700) — so this warns the author that what looks like metadata is being treated as content. The fix is to close the marker: :: label ::.

MissingSessionTarget

A session reference ([#2.1]) whose identifier matches no session in the merged document. Emitted only by the opt-in analyze_references pass (check --references), never by the always-on analyser.

MissingDefinitionTarget

A definition reference ([Title]) whose subject matches no definition in the merged document. Opt-in (check --references).

MissingAnnotationTarget

An annotation reference ([::label]) whose label matches no annotation in the merged document. Opt-in (check --references).

MissingCitationTarget

A citation reference ([@key]) whose key matches no annotation label or definition subject in the merged document. Opt-in (check --references).

MalformedUrl

A URL reference ([http://…], [https://…], [mailto:…]) that is not well-formed (embedded space, empty host, otherwise unparseable). Opt-in (check --references); a pure parse check — network reachability is out of scope. Emitted by analyze_references.

MissingFileTarget

A file-path reference — an inline ReferenceType::File ([./x.txt], [../y], [/abs]) or a verbatim block’s src= parameter — that points at no file on disk, or whose target escapes the resolution root / is a platform-absolute path. Opt-in: emitted only by check --references (the existence check is IO-bearing, so it runs in the CLI seam, not the pure analyser). lex.include src= is excluded — its path is validated by the base command via include expansion.

Implementations

impl DiagnosticKind

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

The on-the-wire code for this diagnostic kind. The same value travels in lsp_types::Diagnostic.code and is the key the [diagnostics.rules] block in .lex.toml matches against (see DiagnosticsRulesConfig::lookup_by_code).

For the Handler variant — extension-emitted diagnostics — this returns the namespace-prefixed code: "acme.foo" for Handler { namespace: "acme", code: Some("foo") }, or "acme.diagnostic" when the handler omitted a code. The namespace prefix is what [diagnostics.rules] keys match against (spec §9), and the per-namespace .diagnostic fallback gives users one knob per namespace for code-less handler diagnostics rather than a single global "handler.diagnostic".

Returns Cow<'static, str> so built-in variants borrow a static string (no allocation) while the Handler variant owns the format!-produced result. apply_rules runs on every document change in the LSP, so avoiding per-built-in allocations matters.

Trait Implementations

impl Clone for DiagnosticKind

fn clone(&self) -> DiagnosticKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiagnosticKind

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

Formats the value using the given formatter.

impl Eq for DiagnosticKind

impl PartialEq for DiagnosticKind

fn eq(&self, other: &DiagnosticKind) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DiagnosticKind