Enum WithExpression 

pub enum WithExpression<T> {
    Expression(Expression),
    Value(T),
}

A value that can be either a literal or an expression.

This allows Function definitions to mix static values with dynamic expressions. During compilation, expressions are evaluated while literal values pass through unchanged.

Example

Literal value:

"hello world"

JMESPath expression:

{"$jmespath": "input.greeting"}

Starlark expression:

{"$starlark": "input['greeting']"}

Variants

Expression(Expression)

An expression (JMESPath or Starlark) to evaluate.

Value(T)

A literal value.

Implementations

impl<T> WithExpression<T>

where T: DeserializeOwned + FromStarlarkValue + FromSpecial,

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

Compiles the value, allowing array results from expressions.

Literal values always return OneOrMany::One. Expressions may return either one or many values.

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

Compiles the value, expecting exactly one result.

Literal values pass through unchanged. Expressions must evaluate to a single value or an array with exactly one element.

impl<T> WithExpression<Option<T>>

pub fn is_none(&self) -> bool

Trait Implementations

impl<'arbitrary, T: Arbitrary<'arbitrary>> Arbitrary<'arbitrary> for WithExpression<T>

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<T: Clone> Clone for WithExpression<T>

fn clone(&self) -> WithExpression<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for WithExpression<T>

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

Formats the value using the given formatter.

impl<T> Default for WithExpression<T>

where T: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for WithExpression<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: FromSpecial> FromSpecial for WithExpression<T>

fn from_special( special: &Special, params: &Params<'_, '_>, ) -> Result<Self, ExpressionError>

impl<T: FromStarlarkValue> FromStarlarkValue for WithExpression<T>

fn from_starlark_value(value: &Value<'_>) -> Result<Self, ExpressionError>

impl<T> JsonSchema for WithExpression<T>

where T: JsonSchema,

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<T: PartialEq> PartialEq for WithExpression<T>

fn eq(&self, other: &WithExpression<T>) -> 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<T> Serialize for WithExpression<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for WithExpression<T>