2个版本
0.0.2 | 2019年3月5日 |
---|---|
0.0.1 | 2019年2月24日 |
#510 in 模板引擎
在 2 crates中使用
10KB
172 行
[WIP] wearte
wearte代表《What Even A Nother Rust Template Engine》,它是最快的Rust模板引擎之一。它使用类似于Handlebars的语法。
此crate是从yarte分叉而来,修复了snarky许可问题。yarte是askama的直接后裔。您可以在LICENSE-MIT中找到它们的许可副本。
为什么需要派生模板引擎?
有许多基于mustache或handlebars的模板引擎,但我不知道有任何一个是将模板编译任务派发到编译器(如askama)。通过将此任务派发到另一个进程,我们可以使用自己的工具或第三方工具(如LLVM)优化生成的指令。在其他情况下,这不可能,这会导致我们的Web服务器出现瓶颈,达到毫秒级别。因此,wearte
将模板优先级分配静态,从而比宏write!
更快地写入,更容易并行处理,并使用其默认HTML转义中的SIMD。
总之,派生是为了更快、更简单。
入门
将wearte依赖项添加到您的Cargo.toml文件中
[dependencies]
wearte = "0.0.1"
为了在模板中使用结构体,您必须调用过程宏 Template
。例如,在以下代码中,我们将使用结构体 CardTemplate
,然后定义 s
为一个具有内容的 CardTemplate
。
use wearte::Template;
#[derive(Template)]
#[template(path = "hello.html")]
struct CardTemplate<'a> {
title: &'a str,
body: &'a str,
}
let template = CardTemplate {
title: "My Title",
body: "My Body",
};
现在,我们的结构体已经定义好了,让我们在模板中使用它。wearte 模板看起来像普通文本,其中包含嵌入的表达式。
假设文件 hello.html
看起来是这样的
<div class="entry">
<h1>{{title}}</h1>
<div class="body">
{{body}}
</div>
</div>
并调用您的模板以在 String
中分配结果并返回它,并用 wearte::Result 包装。
template.call()
<div class="entry">
<h1> My Title </h1>
<div class="body">
My Body
</div>
</div>
模板化
wearte 使用开括号 {{
和闭括号 }}
来解析内部,具体取决于使用的功能。大多数功能由 Handlebars 定义,例如路径、注释、HTML、助手和部分。其他功能,如将 Rust 代码添加到模板中,显然由 wearte 定义。
// precompile your template
#[derive(Template)]
#[template(source = "Hello, {{ name }}!", ext = "txt")]
struct HelloTemplate<'a> {
name: &'a str,
}
assert_eq!(
"Hello, world!",
HelloTemplate { name: "world" }.call().unwrap() // then call it.
);
注释
{{! Comments can be written }}
{{!-- in two different ways --}}
HTML
wearte 会转义由 {{expression}}
返回的值。如果您不希望 wearte 转义值,请使用“三重替换”,{{{
。例如,具有以下结构体的
let t = CardTemplate {
title: "All about <p> Tags",
body: "<p>This is a post about <p> tags</p>"
};
和以下模板
<div class="entry">
<h1>{{title}}</h1>
<div class="body">
{{{body}}}
</div>
</div>
将生成
<div class="entry">
<h1>All About <p> Tags</h1>
<div class="body">
<p>This is a post about <p> tags</p>
</div>
</div>
助手
内置
如果、否则和否则如果助手{{#if isLiked}}
Liked!
{{else if isSeen}}
Seen!
{{else}}
Sorry ...
{{\if}}
使用助手let author = Author {
name: "J. R. R. Tolkien"
};
{{#with author}}
<p>{{name}}</p>
{{/with}}
每个助手{{#each into_iter}}
{{#- if first || last -}}
{{ index }}
{{- else -}}
{{ index0 }}
{{/-if }} {{ key }}
{{\-each}}
除非助手{{#unless isAdministrator-}}
Ask administrator.
{{\-unless}}
[WIP] 日志助手{{#log }} {{log\}}
[WIP] 查找助手{{#lookup }} {{\lookup}}
[WIP] 用户自定义
为了创建用户自定义助手 ..
文本
布尔值、整数、浮点数等不转义以提高性能。如果可能,建议使用这些类型。
部分
可以使用预定义的函数来使用部分生成更快的代码。
{{> path/to/file }}
Rust 代码
wearte 提供了在 HTML 文件中使用原始 Rust 代码的可能性。这是有限的,但支持大多数基本语法。
{{#with getUser(id)?-}}
Hello, {{#if isAdmin || isDev }}Mr. {{\if}}{{ user }}
{{/-with}}
Hello, {{#each conditions}}
{{#-if let Some(check) = cond }}
{{#-if check }}
{{ let cond = if check { "&foo" } else { "&"} }}
{{
if check {
cond
} else if let Some(cond) = key.cond {
if cond {
"1"
} else {
"2"
}
} else {
"for"
}
}}
{{- else if let Some(_) = cond }}
{{- else if let Some(cond) = key.check }}
{{#-if cond -}}
baa
{{/-if }}
{{- else -}}
{{ cond.is_some() }}
{{/-if-}}
{{ cond.is_some() && true }}
{{-else if let Some(cond) = check }}
{{#-if cond -}}
bar
{{/-if}}
{{- else -}}
None
{{/-if
}}{{/each}}!
{{ let mut a = name.chars() }}
{{
let b: String = loop {
if a.next().is_none() && true {
let mut a = name.repeat(1);
a.push('!');
break a.repeat(2);
} else {
continue;
}
}
}}
{{ b }}
{{ let doubled = a.iter().map(|x| x * 2).collect::<Vec<_>>() }}
{{ let doubled: Vec<usize> = a.iter().map(|x| x * 2).collect() }}
{{#each doubled -}}
{{ key + 1 }}
{{/-each}}
路线图
- 最小化文本
- 生成定义的助手和过滤器的构建器
-
>|
过滤器在 fmt::Formatter 上 - 在 fmt::Formatter 上连接过滤器,类似 Unix(当可能时)
- ... 你可以打开一个问题!
依赖关系
~0.6–1.1MB
~27K SLoC