Enum Expression 

pub enum Expression {
    JMESPath(String),
    Starlark(String),
    Special(Special),
}

An expression that can be either JMESPath or Starlark.

Serializes as {"$jmespath": "..."} or {"$starlark": "..."} in JSON.

Examples

JMESPath:

{"$jmespath": "input.items[0].name"}

Starlark:

{"$starlark": "input['items'][0]['name']"}

Variants

JMESPath(String)

A JMESPath expression.

Starlark(String)

A Starlark expression.

Special(Special)

A predefined special expression variant.

Implementations

impl Expression

pub fn compile_one_or_many<T>( &self, params: &Params<'_, '_>, ) -> Result<OneOrMany<T>, ExpressionError>

where T: DeserializeOwned + FromStarlarkValue + FromSpecial,

Compiles the expression, allowing array results.

Returns OneOrMany::One for single values or OneOrMany::Many for arrays. Null values are filtered out from array results. A Single Null value is treated as an empty array.

pub fn compile_one<T>( &self, params: &Params<'_, '_>, ) -> Result<T, ExpressionError>

where T: DeserializeOwned + FromStarlarkValue + FromSpecial,

Compiles the expression, expecting exactly one value.

Accepts a single value or an array with exactly one element. Returns an error if the expression evaluates to null, an empty array, or an array with more than one element.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Expression

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Expression

fn clone(&self) -> Expression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Expression

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Expression

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Expression

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Expression

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Expression

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Expression