Struct srtemplate::SrTemplate

source ·

pub struct SrTemplate<'a> { /* private fields */ }

Expand description

Re-exports the template::function, template::SrTemplate, template::TemplateFunction type for convenient use. This structure is the basis of everything, it is responsible for managing variables and functions.

Examples

use srtemplate::SrTemplate;

let mut ctx = SrTemplate::default();
ctx.add_variable("var", &"World");
ctx.add_variable("otherVar", &"Other");
ctx.add_variable("number", &85u8);

ctx.render("Hello {{ var }}! This is {{ otherVar }} and this is number: {{number}}").unwrap();

Implementations§

source §

impl<'a> SrTemplate<'a>

source

pub fn add_variable<U: Into<Cow<'a, str>>, T: ToString>( &self, name: U, value: &T )

Adds variables that can later be rendered in the template

Arguments

name: Variable name, this name is the one you will use in the template
value: This is the value on which the template will be replaced in the template

Examples found in repository ?

examples/render_struct.rs (line 20)

fn main() {
    let ctx = SrTemplate::default();

    let p = Point { x: 0.0, y: 5.025 };

    ctx.add_variable("point", &p);

    let template = "Point {{ point }}";
    println!("Rendered: {}", ctx.render(template).unwrap());
}

More examples

Hide additional examples

examples/custom_func.rs (line 21)

fn main() {
    let ctx = SrTemplate::default();
    ctx.add_variable("var", &"mUnDo");
    ctx.add_function("toTitle", to_title);

    let template = "Hola {{ toTitle(var) }}";

    println!("Rendered: {}", ctx.render(template).unwrap());
}

examples/parse_args.rs (line 18)

fn main() {
    let ctx = SrTemplate::default();
    ctx.add_variable("var", &"mUnDo");
    ctx.add_variable("other", &255u8);

    ctx.add_function("merge", merge);

    let template = "Hola {{ merge(var, other) }}";

    println!("Rendered: {}", ctx.render(template).unwrap());
}

examples/variables.rs (line 5)

fn main() {
    let ctx = SrTemplate::default();
    ctx.add_variable("var", &"World");
    ctx.add_variable("otherVar", &"Other");
    ctx.add_variable("number", &85u8);

    let template = "Hello {{ var }}! This is {{ otherVar }} and this is number: {{number}}";
    println!("Rendered: {}", ctx.render(template).unwrap());
}

source

pub fn add_function<T: Into<Cow<'a, str>>>( &self, name: T, func: TemplateFunction )

Adds functions that can later be rendered in the template

Arguments

name: Function name, this name is the one you will use in the template
func: This is the function that will be evaluated when it is called from the template

Examples found in repository ?

examples/custom_func.rs (line 22)

fn main() {
    let ctx = SrTemplate::default();
    ctx.add_variable("var", &"mUnDo");
    ctx.add_function("toTitle", to_title);

    let template = "Hola {{ toTitle(var) }}";

    println!("Rendered: {}", ctx.render(template).unwrap());
}

More examples

Hide additional examples

examples/parse_args.rs (line 21)

fn main() {
    let ctx = SrTemplate::default();
    ctx.add_variable("var", &"mUnDo");
    ctx.add_variable("other", &255u8);

    ctx.add_function("merge", merge);

    let template = "Hola {{ merge(var, other) }}";

    println!("Rendered: {}", ctx.render(template).unwrap());
}

source

pub fn render(&self, text: &str) -> Result<String, SrTemplateError>

Renders text as a template, replacing variables and processing functions.

Arguments

text: The text in template format to be processed.

Returns

A Result where Ok contains the rendered template as a String, and Err holds a SrTemplateError if an error occurs.

Example

use srtemplate::prelude::SrTemplate;
use srtemplate::prelude::SrTemplateError;

let ctx = SrTemplate::default();
let template = "Hello, {{ name }}!";
match ctx.render(template) {
    Ok(rendered) => println!("Rendered: {}", rendered),
    Err(err) => eprintln!("Error: {:?}", err),
}

Examples found in repository ?

examples/render_struct.rs (line 23)

fn main() {
    let ctx = SrTemplate::default();

    let p = Point { x: 0.0, y: 5.025 };

    ctx.add_variable("point", &p);

    let template = "Point {{ point }}";
    println!("Rendered: {}", ctx.render(template).unwrap());
}

More examples

Hide additional examples

examples/custom_func.rs (line 26)

fn main() {
    let ctx = SrTemplate::default();
    ctx.add_variable("var", &"mUnDo");
    ctx.add_function("toTitle", to_title);

    let template = "Hola {{ toTitle(var) }}";

    println!("Rendered: {}", ctx.render(template).unwrap());
}

examples/parse_args.rs (line 25)

fn main() {
    let ctx = SrTemplate::default();
    ctx.add_variable("var", &"mUnDo");
    ctx.add_variable("other", &255u8);

    ctx.add_function("merge", merge);

    let template = "Hola {{ merge(var, other) }}";

    println!("Rendered: {}", ctx.render(template).unwrap());
}

examples/variables.rs (line 10)

fn main() {
    let ctx = SrTemplate::default();
    ctx.add_variable("var", &"World");
    ctx.add_variable("otherVar", &"Other");
    ctx.add_variable("number", &85u8);

    let template = "Hello {{ var }}! This is {{ otherVar }} and this is number: {{number}}";
    println!("Rendered: {}", ctx.render(template).unwrap());
}

examples/handle_errors.rs (line 8)

fn main() {
    let ctx = SrTemplate::default();

    let template = "Hi {{ toTitle(var) }}";

    match ctx.render(template) {
        Ok(result) => println!("Rendered: {result}"),
        Err(e) => match e {
            srtemplate::SrTemplateError::BadSyntax(e) => println!("Invalid syntaxis: {e}"),
            srtemplate::SrTemplateError::VariableNotFound(e) => println!("Variable not found: {e}"),
            srtemplate::SrTemplateError::FunctionNotImplemented(e) => {
                println!("Function not supported: {e}")
            }
            srtemplate::SrTemplateError::Function(e) => println!("Error procesing function: {e}"),
        },
    }
}