Struct TemplateNest

pub struct TemplateNest<'a> {
    pub delimiters: (&'a str, &'a str),
    pub label: &'a str,
    pub extension: &'a str,
    pub directory: PathBuf,
    pub show_labels: bool,
    pub comment_delimiters: (&'a str, &'a str),
    pub fixed_indent: bool,
    pub die_on_bad_params: bool,
    pub token_escape_char: &'a str,
    pub defaults: HashMap<String, Filling>,
}

Renders a template hash to produce an output.

Fields

delimiters: (&'a str, &'a str)

Delimiters used in the template. It is a tuple of two strings, representing the start and end delimiters.

label: &'a str

Name label used to identify the template to be used.

extension: &'a str

Template extension, appended on label to identify the template.

directory: PathBuf

Directory where templates are located.

show_labels: bool

Prepend & Append a string to every template which is helpful in identifying which template the output text came from.

comment_delimiters: (&'a str, &'a str)

Used in conjunction with show_labels. If the template is HTML then use ‘’.

fixed_indent: bool

Intended to improve readability when inspecting nested templates.

die_on_bad_params: bool

If True, then an attempt to populate a template with a variable that doesn’t exist (i.e. name not found in template file) results in an error.

token_escape_char: &'a str

Escapes a token delimiter, i.e. if set to ’' then prefixing the token delimiters with ’' means it won’t be considered a variable.

=> is a variable

<!–% token %–> => is not a variable. (’' is removed from output)

defaults: HashMap<String, Filling>

Provide a hash of default values that are substituted if template hash does not provide a value.

Implementations

impl TemplateNest<'_>

pub fn new(directory_str: &str) -> Result<Self, TemplateNestError>

Creates a new instance of TemplateNest with the specified directory.

pub fn render(&self, filling: &Filling) -> Result<String, TemplateNestError>

Given a TemplateHash, it parses the TemplateHash and renders a String output.

Trait Implementations

impl Default for TemplateNest<'_>

fn default() -> Self

Returns the “default value” for a type.