minijinja

Struct Expression

Source
pub struct Expression<'env, 'source> { /* private fields */ }
Expand description

A handle to a compiled expression.

An expression is created via the compile_expression method. It provides a method to evaluate the expression and return the result as value object. This for instance can be used to evaluate simple expressions from user provided input to implement features such as dynamic filtering.

This is usually best paired with context to pass a single value to it.

§Example

let env = Environment::new();
let expr = env.compile_expression("number > 10 and number < 20").unwrap();
let rv = expr.eval(context!(number => 15)).unwrap();
assert!(rv.is_true());

Implementations§

Source§

impl<'env, 'source> Expression<'env, 'source>

Source

pub fn eval<S: Serialize>(&self, ctx: S) -> Result<Value, Error>

Evaluates the expression with some context.

The result of the expression is returned as Value.

Source

pub fn undeclared_variables(&self, nested: bool) -> HashSet<String>

Returns a set of all undeclared variables in the expression.

This works the same as Template::undeclared_variables.

Trait Implementations§

Source§

impl<'env, 'source> Debug for Expression<'env, 'source>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'env, 'source> Freeze for Expression<'env, 'source>

§

impl<'env, 'source> !RefUnwindSafe for Expression<'env, 'source>

§

impl<'env, 'source> Send for Expression<'env, 'source>

§

impl<'env, 'source> Sync for Expression<'env, 'source>

§

impl<'env, 'source> Unpin for Expression<'env, 'source>

§

impl<'env, 'source> !UnwindSafe for Expression<'env, 'source>

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.