Struct rtfmt::StringTemplate

pub struct StringTemplate { /* fields omitted */ }

A template. The syntax for specifying a variable to be replaced is "~{myname}".

let mut template = StringTemplate::new("hello ~{name2} my name is ~{name}");
template.set("name", "grok");
template.set("name2", "traveler");
assert!(template.format() == "hello traveler my name is grok");

Methods

impl StringTemplate

pub fn new(template: impl Into<String>) -> Self

Create a new template from a string.

pub fn set(&mut self, key: impl AsRef<str>, replacement: impl Into<String>)

Set a variable.

pub fn format(&self) -> String

Format the template, producing a string.

Trait Implementations

impl Eq for StringTemplate

impl Ord for StringTemplate

fn cmp(&self, other: &StringTemplate) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<StringTemplate> for StringTemplate

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Clone for StringTemplate

fn clone(&self) -> StringTemplate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<StringTemplate> for StringTemplate

fn partial_cmp(&self, other: &StringTemplate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &StringTemplate) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &StringTemplate) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &StringTemplate) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &StringTemplate) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.