Struct minijinja::Environment

pub struct Environment<'source> { /* fields omitted */ }

An abstraction that holds the engine configuration.

This object holds the central configuration state for templates and their configuration. Instances of this type may be modified if no template were loaded so far. Modifications on environments after the first template was loaded will lead to surprising effects and undefined behavior. For instance overriding the auto escape callback will no longer have effects to an already loaded template.

Implementations

impl<'source> Environment<'source>

pub fn new() -> Environment<'source>

Creates a new environment with sensible defaults.

This environment does not yet contain any templates but it will have all the default filters loaded. If you do not want any default configuration you can use the alternative empty method.

pub fn empty() -> Environment<'source>

Creates a completely empty environment.

This environment has no filters, no templates and no default logic for auto escaping configured.

pub fn set_auto_escape_callback<F: Fn(&str) -> AutoEscape + 'static>(
    &mut self,
    f: F
)

Sets a new function to select the default auto escaping.

This function is invoked when templates are added to the environment to determine the default auto escaping behavior. The function is invoked with the name of the template and can make an initial auto escaping decision based on that. The default implementation is to turn on escaping for templates ending with .html, .htm and .xml.

pub fn add_template(
    &mut self,
    name: &'source str,
    source: &'source str
) -> Result<(), Error>

Loads a template from a string.

The name parameter defines the name of the template which identifies it. To look up a loaded template use the get_template method.

pub fn remove_template(&mut self, name: &str)

Removes a template by name.

pub fn get_template(&self, name: &str) -> Option<Template<'_, 'source>>

Fetches a template by name.

This requires that the template has been loaded with add_template beforehand. If the template was not loaded None is returned.

pub fn compile_expression(
    &self,
    expr: &'source str
) -> Result<Expression<'_, 'source>, Error>

Compiles an expression.

This lets one compile an expression in the template language and receive the output. This lets one use the expressions of the language be used as a minimal scripting language.

pub fn add_filter<F, V, Rv, Args>(&mut self, name: &'source str, f: F) where
    V: TryFrom<Value>,
    Rv: Into<Value>,
    F: Filter<V, Rv, Args>,
    Args: ValueArgs, 

Adds a new filter function.

For details about filters have a look at filters.

pub fn remove_filter(&mut self, name: &str)

Removes a filter by name.

pub fn add_test<F, V, Rv, Args>(&mut self, name: &'source str, f: F) where
    V: TryFrom<Value>,
    F: Test<V, Args>,
    Args: ValueArgs, 

Adds a new test function.

For details about tests have a look at tests.

pub fn remove_test(&mut self, name: &str)

Removes a test by name.

Trait Implementations

impl<'source> Debug for Environment<'source>

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

Formats the value using the given formatter.

impl<'source> Default for Environment<'source>

fn default() -> Self

Returns the “default value” for a type.