Skip to main content

Error

Struct Error 

Source
pub struct Error { /* private fields */ }
Expand description

Unified crate error used by stable public APIs.

§Examples

let err = async_jsonata_rust::Error::new("D3040", "Sqrt domain error");
assert_eq!(err.code(), "D3040");

Implementations§

Source§

impl Error

Source

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

Creates a new error with JSONata-compatible code.

§Examples
let err = async_jsonata_rust::Error::new("S0201", "Unexpected token");
assert_eq!(err.code(), "S0201");
Source

pub fn parser(err: ParserError) -> Self

Creates a parser error from parser internals.

§Examples
let parse_error = async_jsonata_rust::parse_expression("1+", false).unwrap_err();
let err = async_jsonata_rust::Error::from(parse_error);
assert!(!err.code().is_empty());
Source

pub fn runtime(err: JsonError) -> Self

Creates a runtime error from evaluator/function internals.

§Examples
let runtime = async_jsonata_rust::JsonError::new("D3040", "Sqrt domain error");
let err = async_jsonata_rust::Error::from(runtime);
assert_eq!(err.code(), "D3040");
Source

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

Creates a not-implemented error for incomplete features.

§Examples
let err = async_jsonata_rust::Error::not_implemented("evaluator pending");
assert_eq!(err.code(), "E0001");
Source

pub fn with_context(self, key: impl Into<String>, value: Value) -> Self

Adds named context field.

§Examples
let err = async_jsonata_rust::Error::new("E1", "oops")
    .with_context("field", serde_json::Value::String("value".into()));
assert!(err.context().contains_key("field"));
Source

pub fn code(&self) -> &str

Returns JSONata error code (D3040, S0201, …).

Examples found in repository?
examples/basic_eval.rs (line 11)
3fn main() {
4    let parser = Parser::new();
5    match parser.parse("Account.Order[0].Product") {
6        Ok(expr) => {
7            println!("Source: {}", expr.source());
8            println!("AST type: {}", expr.ast()["type"]);
9        }
10        Err(err) => {
11            eprintln!("{}: {}", err.code(), err.message());
12            std::process::exit(1);
13        }
14    }
15}
More examples
Hide additional examples
examples/error_handling.rs (line 7)
4fn main() {
5    match Parser::new().parse("1+") {
6        Ok(_) => println!("Unexpected parse success"),
7        Err(err) => println!("Parse error: {} at {:?}", err.code(), err.position()),
8    }
9
10    match math::sqrt(Some(-1.0)) {
11        Ok(value) => println!("Unexpected sqrt result: {:?}", value),
12        Err(err) => println!("Runtime error: {}: {}", err.code, err.message),
13    }
14}
Source

pub fn message(&self) -> &str

Returns human-readable message.

Examples found in repository?
examples/basic_eval.rs (line 11)
3fn main() {
4    let parser = Parser::new();
5    match parser.parse("Account.Order[0].Product") {
6        Ok(expr) => {
7            println!("Source: {}", expr.source());
8            println!("AST type: {}", expr.ast()["type"]);
9        }
10        Err(err) => {
11            eprintln!("{}: {}", err.code(), err.message());
12            std::process::exit(1);
13        }
14    }
15}
Source

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

Returns parser position if known.

Examples found in repository?
examples/error_handling.rs (line 7)
4fn main() {
5    match Parser::new().parse("1+") {
6        Ok(_) => println!("Unexpected parse success"),
7        Err(err) => println!("Parse error: {} at {:?}", err.code(), err.position()),
8    }
9
10    match math::sqrt(Some(-1.0)) {
11        Ok(value) => println!("Unexpected sqrt result: {:?}", value),
12        Err(err) => println!("Runtime error: {}: {}", err.code, err.message),
13    }
14}
Source

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

Returns token payload if known.

Source

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

Returns parser value payload if known.

Source

pub fn remaining(&self) -> Option<&[Value]>

Returns unparsed trailing token payload if known.

Source

pub fn context(&self) -> &BTreeMap<String, Value>

Returns structured context fields.

Trait Implementations§

Source§

impl Clone for Error

Source§

fn clone(&self) -> Error

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for Error

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

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. Read more
Source§

impl From<JsonError> for Error

Source§

fn from(value: JsonError) -> Self

Converts to this type from the input type.
Source§

impl From<ParserError> for Error

Source§

fn from(value: ParserError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V