Struct LuxError 

pub struct LuxError {
    pub message: String,
    pub span: Span,
    pub note: Option<String>,
    pub learn: Option<(&'static str, &'static str)>,
}

An error with a message, the span it happened at, an optional note, and an optional trail to a lux learn topic — a (topic, lure) pair, where the lure is a one-line hint at why the idea is worth following.

Fields

message: String

span: Span

note: Option<String>

learn: Option<(&'static str, &'static str)>

Implementations

impl LuxError

pub fn new(message: impl Into<String>, span: Span) -> Self

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

Attach a hint about how to fix the problem.

pub fn with_learn(self, topic: &'static str, lure: &'static str) -> Self

Open a trail to the lux learn topic that teaches this, with a one-line lure hinting at why it is worth following. Set it only where there is a clean topic that genuinely covers the mistake; a self-evident fix needs only a note, not a trail.

Trait Implementations

impl Clone for LuxError

fn clone(&self) -> LuxError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LuxError

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

Formats the value using the given formatter.