incrust

Crates.io	incrust
lib.rs	incrust
version	0.2.15
source	src
created_at	2016-05-08 22:45:35.697886
updated_at	2017-04-11 05:51:30.607795
description	Template engine inspired by Jinja2
homepage	https://github.com/alexander-irbis/incrust
repository	https://github.com/alexander-irbis/incrust
max_upload_size
id	5012
size	144,827

Alexander Irbis (alexander-irbis)

documentation

https://docs.rs/incrust/

README

{% Incrust %}

Incrust is a template engine inspired by Jinja2 and written in Rust.

In fact it is a Jinja2, Django, Twig, Swig, Liquid (and probably others) template engines constellation, which uses similar methodologies.

Unstable

The implementation is at a very early stage and the API is a subject of changes.

Note that Incrust currently requires the nightly version of the Rust compiler.

Installation

Incrust is available on crates.io and can be included in your Cargo enabled project like this:

[dependencies]
incrust = "=0.2.15"

For ease of use hashmaps you may use the maplit

Then you need to setup your environment:

#[macro_use]
extern crate maplit;
extern crate incrust;

use incrust::ex;

fn create_env() -> Incrust {
    use incrust::{Incrust, FilesystemLoader};

    let mut instance = Incrust::default();
    instance.loaders.push(FilesystemLoader::new("./assets/tpl"));
    instance
}

fn main() {
    let incrust = create_env();
    let args = hashmap!{ "name".into() => ex("World") };
    incrust.render("hello", &args).unwrap();
}

Though Incrust has smart loaders, it may be used just as advanced formatter to render directly from string template

let args = hashmap!{ "name".into() => ex("World") };
incrust.render_text("Hello, {{ name | e }}!", &args).unwrap();
// or with prepared template
let hello = incrust.parse("Hello, {{ name | e }}!");
incrust.render_parsed(&hello, &args).unwrap();

Syntax examples

Comments

<p>Visible {# partially #} paragraph</p>

<p>Visible  paragraph</p>

Escaping

Example: {% raw %}{{ mustaches }}{% endraw %}

Example: {{ mustaches }}

Literals

Braces: {{ "{{" }}
Pi: {{ 3.1415926 }}

Braces: {{
Pi: 3.1415926

Filters

let args = hashmap!{ "title".into() => ex("<Cats & Dogs>") };

<h1>{{ title | escape }}</h1>

<h1>&lt;Cats &amp; Dogs&gt;</h1>

Expressions

let args = hashmap!{
    "what".into() => ex("Hello"),
    "who".into() => ex("World")
};

Say: "{{ what + ", " + who }}!"

Say: "Hello, World!"

let args = hashmap!{
    "alpha".into() => ex(6isize),
    "omega".into() => ex(7f64)
};

The answer is {{ alpha * omega }}

The answer is 42

Lazy boolean evaluation

Amount: {{ amount and ("" + amount + " pcs") or "-" }}

assert_eq!("Amount: 6 pcs", incrust.render("tpl", &hashmap!{ "amount".into() => ex(6isize) }).unwrap());
assert_eq!("Amount: -", incrust.render("tpl", &hashmap!{ "amount".into() => ex(0isize) }).unwrap());

Conditional statements

String {% if "" %}has chars{% else %}is empty{% endif %}
It's {% if False %}false{% elif True %}true{% endif %}

String is empty
It's true

For-Loop statements

let args = hashmap!{ "fruits".into() => ex(vec![ex("Orange"), ex("Apple"), ex("Banana")]) };

    <ul>
    {%- for fruit in fruits %}
        <li>{{ loop.index }}. {{ fruit | e }}</li>
    {%- endfor %}
    </ul>

    <ul>
        <li>1. Orange</li>
        <li>2. Apple</li>
        <li>3. Banana</li>
    </ul>

Template inheritance

let args = hashmap!{ "parent_layout".into() => ex("default") };
incrust.render("template", &args).unwrap()

default.tpl

<body>
    <h1>{% block title %}Default title{% endblock %}</h1>
    <main>
    {%- block body %}
        <p>Default body<p>
    {%- endblock %}
    </main>
</body>

template.tpl

{% extends parent_layout %}
{% block title -%}
    New title
{%- endblock %}

Output

<body>
    <h1>New title</h1>
    <main>
        <p>Default body<p>
    </main>
</body>

Include

let args = hashmap!{ "menu".into() => ex("default_menu") };
assert_eq!(expected, incrust.render("tpl", &args).unwrap());

default_menu.tpl

    <ul>
        <li><a href="/">Home</a></li>
        <li><a href="/about">About Us</a></li>
    </ul>