Struct jmespath_community::errors::Error

pub struct Error {
    pub kind: Kind,
    pub message: String,
    pub position: Option<Position>,
}

The error type for this crate.

Fields

kind: Kind

One of the valid error Kind values.

message: String

A message indicating the root cause for the error.

position: Option<Position>

The position within a JMESPath expression.

Implementations

impl Error

pub fn too_few_arguments( function_name: &str, min_count: usize, count: usize, is_variadic: bool ) -> Error

Raises a runtime error when not enough arguments are supplied to a JMESPath Function.

pub fn too_many_arguments( function_name: &str, max_count: usize, count: usize ) -> Error

Raises a runtime error when more arguments are supplied than expected by a JMESPath Function.

pub fn undefined_variable(variable_name: &str) -> Error

Raises a runtime error when an undefined variable is evaluated.

pub fn unknown_function(function_name: &str) -> Error

Raises a runtime error when an unknown function is invoked.

Example

use jmespath_community as jmespath;
use jmespath::errors::Kind;
use jmespath::errors::Error;

let err = Error::unknown_function("unknown");

assert_eq!(Kind::UnknownFunction, err.kind);
assert_eq!("Error: unknown-function, the function 'unknown' does not exist", err.to_string());

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy 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)>

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, demand: &mut Demand<'a>)

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

Provides type based access to context intended for error reports.

impl From<ParseError<AST>> for Error

fn from(error: ParseError<AST>) -> Self

Converts to this type from the input type.

impl Ord for Error

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Error> for Error

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Error> for Error

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Error