Struct Interpolation 

pub struct Interpolation { /* private fields */ }

The main entrypoint for this crate. Created with Interpolation::new, this represents a template that can be supplied variables to render.

Implementations

impl Interpolation

pub fn new(input: impl AsRef<str>) -> Result<Self, ParseError>

Create a new Interpolation.

Errors

This function usually errors when there is a syntax error in the interpolation compiler, e.g. an unclosed identifier or an invalid escape.

pub fn render(&self, args: &HashMap<Cow<'_, str>, Cow<'_, str>>) -> String

Renders this template, using the args hashmap to fetch interpolation values from. Said values must be strings. If an interpolation value is not found, it is replaced with an empty string.

pub fn try_render( &self, args: &HashMap<Cow<'_, str>, Cow<'_, str>>, ) -> Result<String, RenderError<'_>>

Renders this template, using the args hashmap to fetch interpolation values from. Said values must be strings.

Errors

If an interpolation value is not found, it is added to the RenderError.

pub fn variables_used(&self) -> impl Iterator<Item = &str>

Returns an iterator over all variables used in this interpolation. Useful if you have a non hashmap item you wish to get items from.

pub fn input_value(&self) -> String

Trait Implementations

impl Clone for Interpolation

fn clone(&self) -> Interpolation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interpolation

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

Formats the value using the given formatter.

impl Hash for Interpolation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Interpolation

fn eq(&self, other: &Interpolation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Interpolation

impl StructuralPartialEq for Interpolation