Struct CompileError 

pub struct CompileError {
    pub category: &'static str,
    pub span: Span,
    pub message: String,
    pub labels: Vec<(Span, String)>,
    pub notes: Vec<String>,
    pub suggestions: Vec<Suggestion>,
}

A compile error.

Fields

category: &'static str

span: Span

message: String

labels: Vec<(Span, String)>

notes: Vec<String>

suggestions: Vec<Suggestion>

v0.26 (ADR 0054): machine-applicable fixes, authored at the diagnosis site — the only place the exact spans and replacement are known. Consumed by the LSP (codeAction) and, later, a CLI --fix.

Implementations

impl CompileError

pub fn new( category: &'static str, span: Span, message: impl Into<String>, ) -> Self

pub fn with_label(self, span: Span, label: impl Into<String>) -> Self

pub fn with_note(self, note: impl Into<String>) -> Self

pub fn with_suggestion( self, message: impl Into<String>, edits: Vec<(Span, String)>, applicability: Applicability, ) -> Self

Attach a machine-applicable fix (v0.26). Mirrors Self::with_note; the suggestion is authored where the diagnostic is raised.

pub fn report<'a>( &'a self, filename: &'a str, ) -> Report<'a, (&'a str, Range<usize>)>

Build an [ariadne::Report] for this error, anchored to the given filename. Colour is on (for the CLI and human-facing test output).

pub fn report_plain<'a>( &'a self, filename: &'a str, ) -> Report<'a, (&'a str, Range<usize>)>

Build a colourless [ariadne::Report], for transcripts committed to the repo — no ANSI escape codes, so the output is byte-stable across machines.

Trait Implementations

impl Clone for CompileError

fn clone(&self) -> CompileError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompileError

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

Formats the value using the given formatter.