Struct CompileError 

pub struct CompileError {
    pub code: ErrorCode,
    pub stage: Stage,
    pub json_pointer_path: Option<String>,
    pub keyword: Option<String>,
    pub observed: Option<String>,
    pub limit: Option<(LimitKind, usize, usize)>,
    pub recoverable: bool,
    pub message: &'static str,
}

A structured compile-time error. Send + Sync; the machine contract is the fields, not message.

Fields

code: ErrorCode

Stable machine code.

stage: Stage

The stage the error arose in.

json_pointer_path: Option<String>

JSON Pointer (RFC 6901) to the offending node, when known.

keyword: Option<String>

The offending keyword, when applicable.

observed: Option<String>

The observed value/shape, when useful for diagnostics.

limit: Option<(LimitKind, usize, usize)>

(kind, observed, cap) when a resource limit produced the error.

recoverable: bool

Whether a fallback path exists for this error.

message: &'static str

Advisory human-readable text. NEVER the machine contract.

Implementations

impl CompileError

pub fn new(code: ErrorCode, stage: Stage, message: &'static str) -> Self

Creates an error with the given code, stage, and advisory message; all optional fields empty.

pub fn with_pointer(self, path: impl Into<String>) -> Self

Attaches a JSON Pointer path.

pub fn with_keyword(self, keyword: impl Into<String>) -> Self

Attaches the offending keyword.

pub fn with_observed(self, observed: impl Into<String>) -> Self

Attaches an observed-value description.

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.

impl Display for CompileError

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

Formats the value using the given formatter.

impl Eq for CompileError

impl Error for CompileError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<CompileError> for SessionError

fn from(e: CompileError) -> Self

Converts to this type from the input type.

impl From<CompileError> for StructuredMatcherError

fn from(error: CompileError) -> Self

Converts to this type from the input type.

impl PartialEq for CompileError

fn eq(&self, other: &CompileError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CompileError