Struct Error 

pub struct Error {
    pub message: String,
    pub code: Option<String>,
    pub phase: Option<String>,
    pub hint: Option<String>,
    pub file: Option<String>,
    pub line: Option<u32>,
    pub column: Option<u32>,
    pub end_line: Option<u32>,
    pub end_column: Option<u32>,
    pub severity: Severity,
}

An error with source location.

Renamed to BeancountError on the TS side to avoid shadowing the JS-builtin Error type. The Rust struct keeps the shorter Error name for internal use; the rename is applied via #[ts(rename = ...)] so consumers see a non-shadowing name.

Fields

message: String

Error message.

code: Option<String>

Stable error code (e.g. "P0001" for a parse error, "E3001" for a validation error). null for errors without a code (generic processing / query / plugin errors). Lets consumers branch on error type instead of matching on message text.

phase: Option<String>

Processing phase that produced the error: typically "parse", "validate", "plugin", or "lint". null when not attributable to a phase. The set is open (the loader phase is a free string), so the TS type is a union of the known values plus string — consumers get autocomplete on the common phases without rejecting others.

hint: Option<String>

Actionable hint for fixing the error, when one is available. null otherwise.

file: Option<String>

Source file the error came from (multi-file ledgers). null for the single-source WASM entry points (parse, check, …).

line: Option<u32>

Start line (1-based). null when the error has no source location (e.g. validation errors not tied to a span). Field is always present on the wire (no skip_serializing_if); see the struct-level schemars(extend) for the required-and-nullable rationale. range(min = 1) enforces the 1-based documented contract on the JSON Schema side (schemars defaults to minimum: 0 for u32).

column: Option<u32>

Start column (1-based). null when the error has no source location. See line above for range rationale.

end_line: Option<u32>

End line (1-based) of the error span. null when no span. See line.

end_column: Option<u32>

End column (1-based) of the error span. null when no span. See line.

severity: Severity

Error severity.

Implementations

impl Error

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

Create a new error with a message.

pub fn with_line(message: impl Into<String>, line: u32) -> Self

Create an error with a (start) line number.

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

Create a warning.

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

Builder: set the stable error code (e.g. "P0001", "E3001").

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

Builder: set the processing phase ("parse", "validate", …).

pub fn with_hint(self, hint: Option<String>) -> Self

Builder: set the actionable hint (no-op for None).

pub fn with_file(self, file: Option<String>) -> Self

Builder: set the source file.

pub fn with_span(self, start: (u32, u32), end: (u32, u32)) -> Self

Builder: set the full 1-based span (start + end line/column).

Trait Implementations

impl Archive for Error

where String: Archive, Option<String>: Archive, Option<u32>: Archive, Severity: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedError

The archived representation of this type.

type Resolver = ErrorResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<Error, __D> for Archived<Error>

where String: Archive, <String as Archive>::Archived: Deserialize<String, __D>, Option<String>: Archive, <Option<String> as Archive>::Archived: Deserialize<Option<String>, __D>, Option<u32>: Archive, <Option<u32> as Archive>::Archived: Deserialize<Option<u32>, __D>, Severity: Archive, <Severity as Archive>::Archived: Deserialize<Severity, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<Error, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl From<LedgerError> for Error

fn from(e: LedgerError) -> Self

Converts to this type from the input type.

impl Serialize for Error

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<__S: Fallible + ?Sized> Serialize<__S> for Error

where String: Serialize<__S>, Option<String>: Serialize<__S>, Option<u32>: Serialize<__S>, Severity: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.