Trait jmespatch::functions::Function

pub trait Function: Sync {
    fn evaluate(
        &self, 
        args: &[Rcvar], 
        ctx: &mut Context
    ) -> Result<Rcvar, JmespathError>;
}

Represents a JMESPath function.

Required methods

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

Evaluates the function against an in-memory variable.

Loading content...

Implementors

impl Function for AbsFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for AvgFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for CeilFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for ContainsFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for CustomFunction

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for EndsWithFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for FloorFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for JoinFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for KeysFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for LengthFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for MapFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for MaxByFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for MaxFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for MergeFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for MinByFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for MinFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for NotNullFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for ReverseFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for SortByFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for SortFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for StartsWithFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for SumFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for ToArrayFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for ToNumberFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for ToStringFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for TypeFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl Function for ValuesFn

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

impl<F> Function for F where
    F: Sync + Fn(&[Rcvar], &mut Context) -> Result<Rcvar, JmespathError>, 

Normal closures can be used as functions.

It is up to the function to validate the provided arguments. If you wish to utilize Signatures or more complex argument validation, it is recommended to use CustomFunction.

fn evaluate(
    &self,
    args: &[Rcvar],
    ctx: &mut Context
) -> Result<Rcvar, JmespathError>

Loading content...