Lib.rs

› 模板引擎 › wearte
#template #html #handlebars #markup #proc-macro

宏 wearte_derive

为 wearte 提供的进程宏包

由 Zoey Riordan，Dirkjan Ochtman，zzau13 贡献

2 个版本

0.0.2 2019 年 3 月 5 日
0.0.1 2019 年 2 月 24 日

#68 in #handlebars

27 每月下载量
在 wearte 中使用

MIT/Apache 和 LGPL-3.0-or-later

105KB
3K SLoC

[WIP] wearte 文档 最新版本 构建状态 下载

wearte 代表 Wow Even Another Rust Template Engine，它是 Rust 中最快的模板引擎之一。它使用类似 Handlebars 的语法。

此包是从 yarte 分支出来的，修复了 snarky 许可问题。yarte 本身是 askama 的直接后代。你可以在 LICENSE-MIT 中找到他们的许可副本。

为什么需要 derive 模板引擎？

有许多基于 mustache 或 handlebars 的模板引擎，但我所知没有一个是将模板编译任务推导到编译器中的（如 askama）。通过将此任务从另一个进程推导出来，我们可以使用自己的工具或第三方工具（如 LLVM）优化生成的指令。在其他情况下这是不可能的，这会导致我们的 Web 服务器达到毫秒级的瓶颈。因此，wearte 通过静态分配其需求来将模板放在优先位置。因此，我们比宏 write! 写得更快，易于并行化，并且在其默认的 html 转义中使用了 simd。

总之，derive 是用来实现最快和最简单的。

入门指南

将 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模板看起来像普通文本，包含嵌入的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会转义由 {{表达式}} 返回的值。如果你不希望wearte转义值，请使用“三重堆栈”，{{{。例如，以下结构体

let t = CardTemplate {
  title: "All about <p> Tags",
  body: "<p>This is a post about &lt;p&gt; tags</p>"
};

以及以下模板

<div class="entry">
  <h1>{{title}}</h1>
  <div class="body">
    {{{body}}}
  </div>
</div>

将产生

<div class="entry">
  <h1>All About &lt;p&gt; Tags</h1>
  <div class="body">
    <p>This is a post about &lt;p&gt; tags</p>
  </div>
</div>

辅助函数

内置

条件、else和else if辅助函数
{{#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}}

路线图

  • 最小化字面量中的html5
  • 为生成定义的辅助函数和过滤器创建构建器
  • >| 对fmt::Formatter的过滤器
  • 在fmt::Formatter上连接过滤器，类似Unix（当可能时）
  • ...你可以打开一个issue！

依赖

~17–29MB
~407K SLoC