6个版本

0.3.0 2019年10月4日
0.2.6 2019年7月29日
0.2.3 2019年6月12日

#15 in #pre-compiled

每月 29 次下载
erst 中使用

MIT 许可证

16KB
330

erst

Docs Crates.io

一个用于创建字符串模板的小型库,类似于 eRubyJSP(使用尖括号百分号标签:<%= expr %>)。

模板预先编译以提高速度和安全性,尽管在启用 dynamic 标志时提供部分动态渲染(需要一些配置)。

用法

use erst::Template;

#[derive(Template)]
#[template(path = "simple.erst", type = "html")]
pub struct Container<'a> {
    pub collection: Vec<&'a str>,
}

fn main() {
    println!("{}", Container { collection: vec!["Hello", "<>", "World"] });
}

simple.erst 看起来像

<div>
    <p>Hello!</p>
    <%
        let desc = format!("Here is your list of {} items:", self.collection.len());
    -%>
    <p><%= desc %></p>
    <ul>
        <% for x in &self.collection { -%>
            <li><%= x %></li>
        <%- } %>
    </ul>
</div>

默认情况下,模板的 path 将解析为当前项目上下文(即,CARGO_MANIFEST_DIR)中 templates 目录内的文件。如果您需要更改此设置,可以将 ERST_TEMPLATES_DIR 环境变量设置为适当的路径。请注意,这仅在使用构建时才是一个问题;由于模板被编译到您的二进制文件中,因此在运行编译后的二进制文件时不需要这种结构/环境变量。

请注意,与 Askama 和许多其他模板系统不同,您需要在模板文件内部使用 self 引用您的 Template 项的任何成员。模板文件基本上是一个函数的主体,该函数接受 &self(其中 self 是链接的 Container 对象)。

请注意,与 Askama 和其他预编译模板系统类似,您可以引用您crate中可用的任何项(结构、函数等)。

目前,仅支持 html 类型(或无类型),具有非常基本的HTML转义。要在模板文件中取消HTML内容的转义,请将内容包装在 Raw 中,例如。

erst::Raw("<p>Hello</p>")

动态

此库还提供了一种避免(重新)编译模板中静态/非Rust部分的方法。

要启用此功能,请将以下内容添加到您的 Cargo.toml

[dependencies]
erst = { version = "0.2", features = ["dynamic"] }

[build-dependencies]
erst = { version = "0.2", features = ["dynamic"] }

您还必须安装一个辅助二进制文件,erst-prepare

cargo install erst-prepare

erst-prepare 是一个小型二进制文件,它将模板的代码部分复制到 $XDG_CACHE_HOME,以便构建脚本可以重新运行,仅针对模板的代码部分进行更改。

然后像这样运行您的项目

erst-prepare && cargo run

如果您有独特的配置,您可能需要使用 --pkg-name--templates-dir 标志来 erst-prepare

erst-prepare --pkg-name my-project --templates-dir /path/to/your/templates/dir

如果您正在使用 dynamic 并且在构建之前没有运行 erst-prepare,则模板可能无法正确渲染。

当前版本:0.3.0

许可证:MIT

依赖项

~7.5MB
~147K SLoC