Struct ByteTemplateBuf

pub struct ByteTemplateBuf { /* private fields */ }

A parsed byte template that owns the source vector.

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 takes ownership of the source data. If you do not need ownership, you can also use ByteTemplate to borrow it instead. Depending on your application, that could prevent creating an unnecessary copy of the source data.

If you have a string instead of a byte slice, you can use Template or TemplateBuf.

Implementations

impl ByteTemplateBuf

pub fn from_vec(source: Vec<u8>) -> Result<Self, ParseError>

Parse a template from a vector of bytes.

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) -> Vec<u8>

Consume the template to get the original source vector.

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

Borrow the template.

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

where M: VariableMap<'b> + ?Sized, M::Value: AsRef<[u8]>,

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<[u8]>].

Trait Implementations

impl Clone for ByteTemplateBuf

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 ByteTemplateBuf

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

Formats the value using the given formatter.

impl From<&ByteTemplate<'_>> for ByteTemplateBuf

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

Converts to this type from the input type.

impl<'a> From<&'a ByteTemplateBuf> for &'a ByteTemplate<'a>

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

Converts to this type from the input type.

impl<'a> From<&'a ByteTemplateBuf> for ByteTemplate<'a>

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

Converts to this type from the input type.

impl From<ByteTemplate<'_>> for ByteTemplateBuf

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

Converts to this type from the input type.