Struct text_placeholder::Template

pub struct Template<'t> { /* fields omitted */ }

A template is composed of tokens, which in turn can represent plain text or a named placeholder.

Implementations

impl<'t> Template<'t>

pub fn new(text: &'t str) -> Self

Generates a Template with boundaries specified by the handlebars syntax, this means that within the string "hello {{key}}" we will have key as a named placeholder.

pub fn new_with_placeholder(text: &'t str, start: &'t str, end: &'t str) -> Self

Generates a Template with boundaries specified by the start and end arguments. Example:

Template::new_with_placeholder("Hello [key]!", "[", "]");

pub fn fill_with_hashmap(&self, replacements: &HashMap<&str, &str>) -> String

Fill the template's placeholders using the provided replacements HashMap in order to to infer values for the named placeholders.

Placeholders without an associated value will be replaced with an empty string.

For a version that generates an error in case a placeholder is missing see fill_with_hashmap_strict.

pub fn fill_with_hashmap_strict(
    &self,
    replacements: &HashMap<&str, &str>
) -> Result<String, Error>

Fill the template's placeholders using the provided replacements HashMap in order to to infer values for the named placeholders.

Placeholders without an associated value will result in a Error::PlaceholderError.

For a version that does not generate an error in case a placeholder is missing see fill_with_hashmap.