rust-sailfish/sailfishDocumentation

• Simple and intuitive syntax inspired by EJS
• Include another template file inside template
• Built-in filters
• Minimal dependencies
• Extremely fast (See benchmarks)
• Better error message
• Syntax highlighting support (vscode, vim)
• Works on Rust 1.89 or later

Dependencies:

[dependencies]
sailfish = "0.11.9"

You can choose to use TemplateSimple to access fields directly:

Template file (templates/hello.stpl):

<html>
  <body>
    <% for msg in messages { %>
      <div><%= msg %></div>
    <% } %>
  </body>
</html>

Code:

use sailfish::TemplateSimple;

#[derive(TemplateSimple)]
#[template(path = "hello.stpl")]
struct HelloTemplate {
    messages: Vec<String>
}

fn main() {
    let ctx = HelloTemplate {
        messages: vec![String::from("foo"), String::from("bar")],
    };
    println!("{}", ctx.render_once().unwrap());
}

Use Template to render through a shared reference and access fields and methods through self:

Template file (templates/hello.stpl):

<html>
  <body>
    <% for msg in &self.messages { %>
      <div><%= msg %></div>
    <% } %>
    <div><%= self.say_hello() %></div>
  </body>
</html>

Code:

use sailfish::Template;

#[derive(Template)]
#[template(path = "hello.stpl")]
struct HelloTemplate {
    messages: Vec<String>
}

impl HelloTemplate {
    fn say_hello(&self) -> String {
        String::from("Hello!")
    }
}

fn main() {
    let ctx = HelloTemplate {
        messages: vec![String::from("foo"), String::from("bar")],
    };
    println!("{}", ctx.render().unwrap());
}

You can find more examples in examples directory.

For mutable or consuming templates with access to self, use TemplateMut or TemplateOnce. See Choosing a template trait for a comparison of all four traits.

• Template inheritance (block, partials, etc.)

🇯🇵 Ryohei Machida

• GitHub: @Kogia-sima

Contributions, issues and feature requests are welcome!

Since sailfish is an immature library, there are many planned features that is on a stage of RFC. Please leave a comment if you have an idea about its design!

Also I welcome any pull requests to improve sailfish! Find issues with Status: PR Welcome label, and let's create a new pull request!

Give a ⭐️ if this project helped you!

Copyright © 2020 Ryohei Machida.

This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator

sudo apt install mkdocs mkdocs-material
cd sailfish_root_folder &&
cd docs && cd en 
mkdocs build