Struct Template

pub struct Template {
    pub name: String,
    pub path: Option<String>,
    pub ast: Vec<Node>,
    pub from_extend: bool,
    pub macros: HashMap<String, MacroDefinition>,
    pub imported_macro_files: Vec<(String, String)>,
    pub parent: Option<String>,
    pub blocks: HashMap<String, Block>,
    pub parents: Vec<String>,
    pub blocks_definitions: HashMap<String, Vec<(String, Block)>>,
}

This is the parsed equivalent of a template file. It also does some pre-processing to ensure it does as little as possible at runtime Not meant to be used directly.

Fields

name: String

Name of the template, usually very similar to the path

path: Option<String>

Original path of the file. A template doesn’t necessarily have a file associated with it though so it’s optional.

ast: Vec<Node>

Parsed AST, after whitespace removal

from_extend: bool

Whether this template came from a call to Tera::extend, so we do not remove it when we are doing a template reload

macros: HashMap<String, MacroDefinition>

Macros defined in that file: name -> definition ast

imported_macro_files: Vec<(String, String)>

(filename, namespace) for the macros imported in that file

parent: Option<String>

Only used during initial parsing. Rendering will use self.parents

blocks: HashMap<String, Block>

Only used during initial parsing. Rendering will use self.blocks_definitions

parents: Vec<String>

The full list of parent templates

blocks_definitions: HashMap<String, Vec<(String, Block)>>

The definition of all the blocks for the current template and the definition of those blocks in parent templates if there are some. Needed for super() to work without having to find them each time. The type corresponds to the following block_name -> [(template name, definition)] The order of the Vec is from the first in hierarchy to the current template and the template name is needed in order to load its macros if necessary.

Implementations

impl Template

pub fn new( tpl_name: &str, tpl_path: Option<String>, input: &str, ) -> Result<Template, Error>

Parse the template string given

Trait Implementations

impl Clone for Template

fn clone(&self) -> Template

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Template

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

Formats the value using the given formatter.