Struct LedgerError 

#[non_exhaustive]
pub struct LedgerError {
    pub severity: ErrorSeverity,
    pub code: String,
    pub message: String,
    pub location: Option<ErrorLocation>,
    pub source_span: Option<(usize, usize)>,
    pub file_id: Option<u16>,
    pub phase: String,
}

Unified error type for ledger processing.

This encompasses all error types that can occur during loading, booking, plugin execution, and validation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

severity: ErrorSeverity

Error severity.

code: String

Error code (e.g., “E0001”, “W8002”).

message: String

Human-readable error message.

location: Option<ErrorLocation>

Source location, if available.

source_span: Option<(usize, usize)>

Byte span (inclusive start, exclusive end) in the source file, used by rich renderers (e.g. miette) to draw a snippet around the offending directive. Consumers that only need file:line:col should use location; those that want to show the surrounding source text want this.

file_id: Option<u16>

Source file ID — index into the ledger’s SourceMap. Used alongside source_span for snippet rendering.

phase: String

Processing phase that produced this error: “parse”, “validate”, or “plugin”.

Implementations

impl LedgerError

pub fn error(code: impl Into<String>, message: impl Into<String>) -> Self

Create a new error with the given phase.

pub fn warning(code: impl Into<String>, message: impl Into<String>) -> Self

Create a new warning.

pub const fn with_source_span(self, span: (usize, usize), file_id: u16) -> Self

Attach a source span and file ID so rich renderers can draw a snippet.

pub fn with_phase(self, phase: impl Into<String>) -> Self

Set the processing phase for this error.

pub fn with_location(self, location: ErrorLocation) -> Self

Add a location to this error.

Trait Implementations

impl Debug for LedgerError

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

Formats the value using the given formatter.