Struct TemplateBuf 

pub struct TemplateBuf { /* private fields */ }

A parsed string template that owns the source string.

You can parse the template once and call Self::expand() multiple times. This is generally more efficient than calling substitute() multiple times on the same string.

This template owns the source string. If you do not need ownership, you can also use Template to borrow it instead. Depending on your application, that could prevent creating an unnecessary copy of the source data.

If you have a byte slice or vector instead of a string, you can use ByteTemplate or ByteTemplateBuf.

Implementations

impl TemplateBuf

pub fn from_string(source: String) -> Result<Self, ParseError>

Parse a template from a string.

This takes ownership of the string.

The source is can contain variables to be substituted later, when you call Self::expand().

Variables have the form $NAME, ${NAME} or ${NAME:default}. A variable name can only consist of ASCII letters, digits and underscores. They are allowed to start with numbers.

You can escape dollar signs, backslashes, colons and braces with a backslash.

pub fn into_source(self) -> String

Consume the template to get the original source string.

pub fn as_template<'a>(&'a self) -> &'a Template<'a>

Borrow the template.

pub fn expand<'b, M>(&self, variables: &'b M) -> Result<String, ExpandError>

where M: VariableMap<'b> + ?Sized, M::Value: AsRef<str>,

Expand the template.

This will substitute all variables in the template with the values from the given map.

You can pass either a HashMap, BTreeMap or Env as the variables parameter. The maps must have &str or String keys, and the values must be AsRef<str>.

Trait Implementations

impl Clone for TemplateBuf

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateBuf

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

Formats the value using the given formatter.

impl From<&Template<'_>> for TemplateBuf

fn from(other: &Template<'_>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a TemplateBuf> for &'a Template<'a>

fn from(other: &'a TemplateBuf) -> Self

Converts to this type from the input type.

impl<'a> From<&'a TemplateBuf> for Template<'a>

fn from(other: &'a TemplateBuf) -> Self

Converts to this type from the input type.

impl From<Template<'_>> for TemplateBuf

fn from(other: Template<'_>) -> Self

Converts to this type from the input type.