#string #run-time #template

new_string_template

Simple Customizable String-Templating Library for Rust

8 stable releases

1.5.1 Apr 6, 2024
1.4.0 Aug 30, 2022
1.3.1 May 26, 2022
1.3.0 Mar 5, 2022
1.0.0 May 28, 2021

#21 in Template engine

Download history 4344/week @ 2024-01-29 4464/week @ 2024-02-05 5421/week @ 2024-02-12 6815/week @ 2024-02-19 6099/week @ 2024-02-26 7557/week @ 2024-03-04 4691/week @ 2024-03-11 7290/week @ 2024-03-18 5905/week @ 2024-03-25 6950/week @ 2024-04-01 7007/week @ 2024-04-08 6929/week @ 2024-04-15 8532/week @ 2024-04-22 5993/week @ 2024-04-29 5930/week @ 2024-05-06 15031/week @ 2024-05-13

36,169 downloads per month
Used in 3 crates

MIT license

27KB
335 lines

New String Template

Simple Customizable String-Templating Library for Rust.

This Library is inspired by string_template

Usage

Add this to your Cargo.toml (or use cargo-add):

[dependencies]
new_string_template = "1.5"

Example with 2 data points (with fail enabled):

use new_string_template::template::Template;
use std::collections::HashMap;

fn main() {
    let templ_str = "Something {data1} be {data2}, and { not here }";
    let templ = Template::new(templ_str);
    let data = {
        let mut map = HashMap::new();
        map.insert("data1", "should");
        map.insert("data2", "here");
        map
    };

    let rendered = templ.render(&data).expect("Expected Result to be Ok");
    assert_eq!("Something should be here, and { not here }", rendered);
}

Example with 1 data point (with fail disabled):

use new_string_template::template::Template;
use std::collections::HashMap;

fn main() {
    let templ_str = "Something {data1} be {data2}, and { not here }";
    let templ = Template::new(templ_str);
    let data = {
        let mut map = HashMap::new();
        map.insert("data1", "should");
        // map.insert("data2", "here");
        map
    };

    let rendered = templ.render_nofail(&data);
    assert_eq!("Something should be {data2}, and { not here }", rendered);
}

Example with Custom Regex:

use new_string_template::template::Template;
use std::collections::HashMap;
use regex::Regex;

fn main() {
    // The following regex requires at least one space between "{{" and "}}" and allows variables with spaces
    let custom_regex = Regex::new(r"(?mi)\{\{\s+([^\}]+)\s+\}\}").unwrap();
    let templ_str = "Something {{ data1 }} be {{ data2 }}, and {{ data 3 }}";
    let templ = Template::new(templ_str).with_regex(&custom_regex);
    let data = {
        let mut map = HashMap::new();
        map.insert("data1", "should");
        map.insert("data2", "here");
        map.insert("data 3", "here too");
        map
    };

    let rendered = templ.render_nofail(&data);
    assert_eq!("Something should be here, and here too", rendered);
}

Note: with the default regex, a template-variable can have spaces or none at all.

Working on this Project

This project requires:

  • Rust install with rustfmt & clippy (nightly version of mentioned components), see fmt.sh and clippy.sh

Dependencies

~2.2–3MB
~54K SLoC