Struct upon::Renderer

pub struct Renderer<'render> { /* private fields */ }

A renderer that interprets a compiled Template or TemplateRef.

This struct is created by one of the following functions:

• Template{,Ref}::render
• Template{,Ref}::render_from
• Template{,Ref}::render_from_fn

Implementations

impl<'render> Renderer<'render>

pub fn with_template_fn<F>(self, template_fn: F) -> Self

where F: FnMut(&str) -> Result<&'render Template<'render>, String> + 'render,

Set a function that is called when a template is included.

This allows custom template resolution on a per render basis. The default is to look for the template with the exact matching name in the engine, i.e. the same as Engine::get_template.

pub fn with_max_include_depth(self, depth: usize) -> Self

Set the maximum length of the template render stack.

This is the maximum number of nested {% include ... %} statements that are allowed during rendering, as counted from the root template.

Defaults to the engine setting.

pub fn to_string(self) -> Result<String>

Render the template to a string.

pub fn to_writer<W>(self, w: W) -> Result<()>

where W: Write,

Render the template to the given writer.