Struct SemanticDiagnostic 

pub struct SemanticDiagnostic {
    pub span: Span,
    pub message: String,
    pub severity: Severity,
    pub code: Option<String>,
    pub file_id: Option<String>,
    pub related: Vec<RelatedLocation>,
}

A single diagnostic from semantic analysis or validation (e.g. undefined variable, type error).

Use with SemanticDiagnostic::format_with_source or SemanticDiagnostic::into_miette (with the miette feature) so tools and IDEs can show consistent, pluggable error output.

Fields

span: Span

Source span (half-open byte range) for highlighting.

message: String

Human-readable message.

severity: Severity

Error, warning, or note.

code: Option<String>

Optional code (e.g. "E0425", "unused_variable") for filtering and docs.

file_id: Option<String>

Optional file id or path for multi-file compilers (e.g. "src/main.leek").

related: Vec<RelatedLocation>

Optional related locations (e.g. first declaration for duplicate name errors).

Implementations

impl SemanticDiagnostic

pub fn format_with_source( &self, source: &[u8], line_index: &LineIndex, ) -> String

Format this diagnostic with line/column and source snippet.

Uses line_index to resolve span.start to a line and column, then appends the line of source and a caret. Callers can use [ParsedDoc] to get source and line_index from a successful parse.

pub fn error(span: Span, message: impl Into<String>) -> SemanticDiagnostic

Build a diagnostic for an error at the given span.

pub fn warning(span: Span, message: impl Into<String>) -> SemanticDiagnostic

Build a diagnostic for a warning at the given span.

pub fn deprecation(span: Span, message: impl Into<String>) -> SemanticDiagnostic

Build a diagnostic for use of deprecated syntax or API.

pub fn with_code(self, code: impl Into<String>) -> SemanticDiagnostic

Set an optional code (e.g. for filtering or docs).

pub fn with_file_id(self, file_id: impl Into<String>) -> SemanticDiagnostic

Set an optional file id or path (for multi-file diagnostics).

pub fn with_related(self, related: Vec<RelatedLocation>) -> SemanticDiagnostic

Add related locations (e.g. “first declared here” for duplicate name errors).

impl SemanticDiagnostic

pub fn into_miette( &self, source: impl Into<String>, name: impl Into<String>, ) -> MietteSemanticDiagnostic

Convert this diagnostic into a value implementing miette::Diagnostic for pretty-printed reports with source snippets.

Trait Implementations

impl Clone for SemanticDiagnostic

fn clone(&self) -> SemanticDiagnostic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SemanticDiagnostic

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

Formats the value using the given formatter.