Struct string_template_plus::RenderOptions

pub struct RenderOptions {
    pub wd: PathBuf,
    pub variables: HashMap<String, String>,
    pub shell_commands: bool,
}

Options for the Template to render into String

Fields

wd: PathBuf

Working Directory for the Shell Commands

variables: HashMap<String, String>

Variables to use for the template

shell_commands: bool

Run Shell Commands for the output or not

Implementations

impl RenderOptions

pub fn render(&self, templ: &Template) -> Result<String, Error>

pub fn render_iter<'a>(&'a self, templ: &'a Template) -> RenderIter<'a>

Makes a [RenderIter<'a>] that can generate incremented strings from the given Template and the RenderOptions. The Iterator will have -N appended where N is the number representing the number of instance.

    let templ = Template::parse_template("hello {name}").unwrap();
    let mut vars: HashMap<String, String> = HashMap::new();
    vars.insert("name".into(), "world".into());
    let options = RenderOptions {
        variables: vars,
        ..Default::default()
    };
    let mut names = options.render_iter(&templ);
    assert_eq!("hello world-1", names.next().unwrap());
    assert_eq!("hello world-2", names.next().unwrap());
    assert_eq!("hello world-3", names.next().unwrap());

Trait Implementations

impl Clone for RenderOptions

fn clone(&self) -> RenderOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RenderOptions

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

Formats the value using the given formatter.

impl Default for RenderOptions

fn default() -> RenderOptions

Returns the “default value” for a type.