Skip to main content

Runtime

Struct Runtime 

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

Compiles JMESPath expressions.

Most use cases don’t need to worry about how Runtime works. You really only need to create your own Runtimes if you are utilizing custom functions in your expressions.

Implementations§

Source§

impl Runtime

Source

pub fn new() -> Runtime

Creates a new Runtime.

Source

pub fn compile<'a>( &'a self, expression: &str, ) -> Result<Expression<'a>, JmespathError>

Creates a new JMESPath expression from an expression string.

The provided expression is expected to adhere to the JMESPath grammar: http://jmespath.org/specification.html

Source

pub fn register_function(&mut self, name: &str, f: Box<dyn Function>)

Adds a new function to the runtime.

Source

pub fn deregister_function(&mut self, name: &str) -> Option<Box<dyn Function>>

Removes a function from the runtime.

Returns the function that was removed if it was found.

Source

pub fn get_function<'a>(&'a self, name: &str) -> Option<&'a dyn Function>

Gets a function by name from the runtime.

Source

pub fn register_builtin_functions(&mut self)

Registers all of the builtin JMESPath functions with the runtime.

Trait Implementations§

Source§

impl Default for Runtime

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> 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, 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.