Struct Error 

pub struct Error(/* private fields */);

An error raised while compiling or evaluating a JSONata expression.

Every error carries a stable JSONata error code (for example S0201 for a syntax error or T2001 for a type error), so callers can match on codes rather than on messages. Extra details (such as token or value) fill in the code’s message template.

Implementations

impl Error

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

Creates an error with the given code and no details.

pub fn with(self, key: &str, value: impl Into<JsonValue>) -> Self

Adds a detail used by the message template (for example token or value).

pub fn code(&self) -> &str

The JSONata error code, such as S0201.

pub fn message(&self) -> String

The human-readable message, built from the code’s template and the error details.

pub fn position(&self) -> Option<usize>

Position in the expression source where the error was detected, if known.

Like jsonata-js, this is an offset in UTF-16 code units, usually pointing just after the offending token. Use Error::span for byte ranges.

pub fn span(&self) -> Option<Span>

Byte range of the offending source text, if known.

pub fn token(&self) -> Option<String>

The token involved in the error, if any.

pub fn value(&self) -> Option<&JsonValue>

The value involved in the error, if any.

pub fn detail(&self, key: &str) -> Option<&JsonValue>

Any other detail of the error, by name (for example index or functionName).

Trait Implementations

impl Clone for Error

fn clone(&self) -> Self

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 Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<&Error> for AuditError

fn from(e: &Error) -> Self

Converts to this type from the input type.

impl From<&Error> for Diagnostic

fn from(error: &Error) -> Self

Converts to this type from the input type.

impl PartialEq for Error

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Error

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Error