Struct minijinja::State

source ·
pub struct State<'vm, 'env> { /* private fields */ }
Expand description

Provides access to the current execution state of the engine.

A read only reference is passed to filter functions and similar objects to allow limited interfacing with the engine. The state is useful to look up information about the engine in filter, test or global functions. It not only provides access to the template environment but also the context variables of the engine, the current auto escaping behavior as well as the auto escape flag.

Notes on lifetimes: the state object exposes some of the internal lifetimes through the type. You should always elide these lifetimes as there might be lifetimes added or removed between releases.

Implementations§

source§

impl<'vm, 'env> State<'vm, 'env>

source

pub fn env(&self) -> &Environment<'_>

Returns a reference to the current environment.

source

pub fn name(&self) -> &str

Returns the name of the current template.

source

pub fn auto_escape(&self) -> AutoEscape

Returns the current value of the auto escape flag.

source

pub fn undefined_behavior(&self) -> UndefinedBehavior

Returns the current undefined behavior.

source

pub fn current_block(&self) -> Option<&str>

Returns the name of the innermost block.

source

pub fn current_call(&self) -> Option<&str>

Returns the name of the item (filter, function, test, method) currently being called.

source

pub fn lookup(&self, name: &str) -> Option<Value>

Looks up a variable by name in the context.

Trait Implementations§

source§

impl<'a> ArgType<'a> for &State<'_, '_>

§

type Output = &'a State<'a, 'a>

The output type of this argument.
source§

impl<'vm, 'env> Debug for State<'vm, 'env>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'vm, 'env> !RefUnwindSafe for State<'vm, 'env>

§

impl<'vm, 'env> Send for State<'vm, 'env>

§

impl<'vm, 'env> Sync for State<'vm, 'env>

§

impl<'vm, 'env> Unpin for State<'vm, 'env>where 'env: 'vm,

§

impl<'vm, 'env> !UnwindSafe for State<'vm, 'env>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · 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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.