18个版本 (1 个稳定版)

1.0.0 2024年3月24日
0.14.0 2022年6月7日
0.13.0 2021年12月14日
0.12.0 2021年7月14日
0.5.0 2019年3月20日

#19 in #mustache

Download history 357/week @ 2024-04-08 593/week @ 2024-04-15 448/week @ 2024-04-22 588/week @ 2024-04-29 590/week @ 2024-05-06 699/week @ 2024-05-13 694/week @ 2024-05-20 516/week @ 2024-05-27 582/week @ 2024-06-03 501/week @ 2024-06-10 379/week @ 2024-06-17 601/week @ 2024-06-24 339/week @ 2024-07-01 639/week @ 2024-07-08 624/week @ 2024-07-15 565/week @ 2024-07-22

2,236 每月下载量
ramhorns 中使用

MPL-2.0 许可证

20KB
319

Ramhorns logo

Ramhorns

Tests badge Crates.io version badge Docs Crates.io license badge

Ramhorns是纯Rust实现的快速Mustache模板引擎。

Ramhorns 在运行时加载和处理模板。它提供了一个 derive 宏,允许模板从原生Rust数据结构中渲染,无需进行临时分配、中间 HashMap 或其他操作。

借助一点魔法 🎩、友谊的力量 🥂 和 FNV哈希 ✨ 的光芒,渲染时间可以轻松与静态模板引擎(如 Askama)相媲美。

Cargo.toml

[dependencies]
ramhorns = "0.5"

示例

use ramhorns::{Template, Content};

#[derive(Content)]
struct Post<'a> {
    title: &'a str,
    teaser: &'a str,
}

#[derive(Content)]
struct Blog<'a> {
    title: String,        // Strings are cool
    posts: Vec<Post<'a>>, // &'a [Post<'a>] would work too
}

// Standard Mustache action here
let source = "<h1>{{title}}</h1>\
              {{#posts}}<article><h2>{{title}}</h2><p>{{teaser}}</p></article>{{/posts}}\
              {{^posts}}<p>No posts yet :(</p>{{/posts}}";

let tpl = Template::new(source).unwrap();

let rendered = tpl.render(&Blog {
    title: "My Awesome Blog!".to_string(),
    posts: vec![
        Post {
            title: "How I tried Ramhorns and found love 💖",
            teaser: "This can happen to you too",
        },
        Post {
            title: "Rust is kinda awesome",
            teaser: "Yes, even the borrow checker! 🦀",
        },
    ]
});

assert_eq!(rendered, "<h1>My Awesome Blog!</h1>\
                      <article>\
                          <h2>How I tried Ramhorns and found love 💖</h2>\
                          <p>This can happen to you too</p>\
                      </article>\
                      <article>\
                          <h2>Rust is kinda awesome</h2>\
                          <p>Yes, even the borrow checker! 🦀</p>\
                      </article>");

功能

  • 渲染常见类型,如 &strStringbool 和数字到 {{变量}}
  • 使用 {{{三重括号-大括号}}}{{&ampersand}} 进行未转义打印。
  • 渲染代码块 {{#foo}} ... {{/foo}}
  • 渲染逆段落 {{^foo}} ... {{/foo}}
  • 渲染部分 {{>file.html}}
  • 从标记为 #[md] 的字段进行零拷贝 CommonMark 渲染。

基准测试

渲染一个小型模板

test a_simple_ramhorns            ... bench:          82 ns/iter (+/- 4) = 1182 MB/s
test b_simple_askama              ... bench:         178 ns/iter (+/- 8) = 544 MB/s
test c_simple_tera                ... bench:         416 ns/iter (+/- 98) = 233 MB/s
test c_simple_tera_from_serialize ... bench:         616 ns/iter (+/- 33) = 157 MB/s
test d_simple_mustache            ... bench:         613 ns/iter (+/- 34) = 158 MB/s
test e_simple_handlebars          ... bench:         847 ns/iter (+/- 40) = 114 MB/s

带有部分的小型模板渲染

test pa_partials_ramhorns         ... bench:          85 ns/iter (+/- 7) = 1141 MB/s
test pb_partials_askama           ... bench:         210 ns/iter (+/- 9) = 461 MB/s
test pc_partials_mustache         ... bench:         827 ns/iter (+/- 39) = 117 MB/s
test pd_partials_handlebars       ... bench:         846 ns/iter (+/- 29) = 114 MB/s

从字符串编译模板

test xa_parse_ramhorns            ... bench:         190 ns/iter (+/- 10) = 821 MB/s
test xb_parse_mustache            ... bench:       3,229 ns/iter (+/- 159) = 48 MB/s
test xe_parse_handlebars          ... bench:       6,883 ns/iter (+/- 383) = 22 MB/s

值得注意的是,Askama 在编译时处理模板,并为渲染生成静态 Rust 代码。这对于性能来说非常好,但也意味着您不能在不重新编译 Rust 二进制文件的情况下更换模板。在某些情况下,例如对于静态网站生成器,这很不幸是一个决定性因素。

在运行时解析模板永远不会免费,然而 RamhornsLogos 的基础上构建了一个非常快速的解析器,这使得整个过程变得非常迅速。

设计特性和功能集上与 Ramhorns 最接近的是 Mustache crate

许可证

Ramhorns 是免费软件,并按照 Mozilla Public License 版本 2.0 的条款发布。请参阅 LICENSE

依赖关系

~2MB
~44K SLoC