Skip to main content

Engine

Struct Engine 

Source
pub struct Engine { /* private fields */ }
Expand description

A template engine that compiles templates into an AST and renders them.

Templates are added by name and can reference each other via {% include %} and {% extends %} / {% block %}.

Implementations§

Source§

impl Engine

Source

pub fn new(mode: EscapeMode) -> Self

Create a new engine with the given escaping mode.

Source

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

Compile and register a template by name.

Returns an error if the template source contains invalid syntax (e.g. unclosed {{ }}, mismatched {% if %} / {% endif %}) or if a template with the same name already exists.

Source

pub fn render<S: Serialize>( &self, name: &str, variables: S, ) -> Result<String, Error>

Render a named template with the given context variables.

The variables argument can be any type that implements Serialize (e.g. serde_json::Value, a struct with #[derive(Serialize)]).

Returns an error if the template name is not registered or if an expression fails during rendering.

Auto Trait Implementations§

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.