# markup.rs
> A blazing fast, type-safe template engine for Rust.
`markup.rs` is a template engine for Rust powered by procedural macros which
parses the template at compile time and generates optimal Rust code to render
the template at run time. The templates may embed Rust code which is type
checked by the Rust compiler enabling full type-safety.
## Quick Start
Add the `markup` crate to your dependencies:
```toml
[dependencies]
markup = "0.1"
```
Define your template using the `markup::define!` macro:
```rust
markup::define! {
Hello<'a>(name: &'a str) {
{markup::Doctype}
html {
head {
title { "Hello " {name} }
}
body {
div#main.container {
{Greeting { name: "Everyone!" }}
br;
{Greeting { name: name }}
}
}
}
}
Greeting<'a>(name: &'a str) {
p.greeting.{if *name == "Ferris" { Some("ferris" ) } else { None }} {
"Hello "
span.name {
@if *name == "Ferris" {
"FERRIS"
@for _ in 0..3 {
"!"
}
} else {
{name}
}
}
}
}
}
```
Render your template by either:
1. Writing it to any instance of `std::io::Write`:
```rust
write!(writer, "{}", Hello { name: "Ferris" });
```
2. Converting it to a string and using it however you like:
```rust
let string = Hello { name: "Ferris" }.to_string();
```
The above template compiles to:
```rust
pub struct Hello<'a> {
pub name: &'a str,
}
impl<'a> std::fmt::Display for Hello<'a> {
fn fmt(&self, __writer: &mut std::fmt::Formatter) -> std::fmt::Result {
use std::fmt::Display;
let Hello { name } = self;
markup::Render::render(&(markup::Doctype), __writer)?;
__writer.write_str("<html><head><title>Hello ")?;
markup::Render::render(&(name), __writer)?;
__writer.write_str("</title></head><body><div id=\"main\" class=\"container\">")?;
markup::Render::render(&(Greeting { name: "Everyone!" }), __writer)?;
__writer.write_str("<br>")?;
markup::Render::render(&(Greeting { name: name }), __writer)?;
__writer.write_str("</div></body></html>")?;
Ok(())
}
}
pub struct Greeting<'a> {
pub name: &'a str,
}
impl<'a> std::fmt::Display for Greeting<'a> {
fn fmt(&self, __writer: &mut std::fmt::Formatter) -> std::fmt::Result {
use std::fmt::Display;
let Greeting { name } = self;
__writer.write_str("<p class=\"greeting ")?;
markup::Render::render(
&(if *name == "Ferris" {
Some("ferris")
} else {
None
}),
__writer,
)?;
__writer.write_str("\">Hello <span class=\"name\">")?;
if *name == "Ferris" {
__writer.write_str("FERRIS!")?;
for _ in 0..3 {
__writer.write_str("!")?;
}
} else {
markup::Render::render(&(name), __writer)?;
}
__writer.write_str("</span></p>")?;
Ok(())
}
}
```
Rendering the template produces (manually prettified):
```html
<!DOCTYPE html>
<html>
<head>
<title>Hello Ferris</title>
</head>
<body>
<div id="main" class="container">
<p class="greeting ">Hello <span class="name">Everyone!</span></p>
<br>
<p class="greeting ferris">Hello <span class="name">FERRIS!!!</span></p>
</div>
</body>
</html>
```
## Syntax
### Define
```rust
markup::define! {
First {
"First!"
}
Second {
"Second!"
}
}
```
```rust
println!("{}", First);
println!("{}", Second.to_string());
```
```html
First!
Second!
```
### Literal Strings and Expressions
```rust
markup::define! {
Hello {
"Hello,"
" "
"world!\n"
{1 + 2}
{format!("{}{}", 3, 4)}
{if true { Some(5) } else { None }}
{if false { Some(6) } else { None }}
}
}
```
```rust
println!("{}", Hello {});
```
```html
Hello, world!
3345
```
### Elements
#### Normal and Void
```rust
markup::define! {
Hello {
div {}
br;
}
}
```
```rust
println!("{}", Hello {});
```
```html
<div></div><br>
```
#### id and class shorthands
```rust
markup::define! {
Hello {
.foo {
.bar {}
}
button#go.button."button-blue" {}
button#"go-back".{1 + 2}.{2 + 3} {}
}
}
```
```rust
println!("{}", Hello {});
```
```html
<div class="foo"><div class="bar"></div></div><button id="go" class="button button-blue"></button><button id="go-back" class="3 5"></button>
```
#### Attributes with and without values
```rust
markup::define! {
Hello {
div[a = 1, b = "2", c? = true, d? = false, "e-f" = 3, {"g".to_string() + "-h"} = 4, i = None::<i32>, j = Some(5)] {}
"\n"
br[k = 6];
"\n"
input[type = "text"];
}
}
```
```rust
println!("{}", Hello {});
```
```html
<div a="1" b="2" c e-f="3" g-h="4" j="5"></div>
<br k="6">
<input type="text">
```
#### Children
```rust
markup::define! {
Hello {
.foo[a = 1] {
"One"
{0 + 1}
}
div {
"Two"
{1 + 1}
}
}
}
```
```rust
println!("{}", Hello {});
```
```html
<div class="foo" a="1">One1</div><div>Two2</div>
```
### Disable Automatic HTML Escaping
```rust
markup::define! {
Hello {
"<&\">"
{markup::Raw("<span></span>")}
}
}
```
```rust
println!("{}", Hello {});
```
```html
<&"><span></span>
```
### Arguments
```rust
markup::define! {
Hello(foo: u32, bar: u32, string: String) {
div {
{foo + bar}
{string}
}
}
}
```
```rust
println!("{}", Hello { foo: 1, bar: 2, string: String::from("hello") });
```
```html
<div>3hello</div>
```
```rust
markup::define! {
Hello<'a, T: std::fmt::Debug, U>(arg: T, arg2: U, str: &'a str) where U: std::fmt::Display {
div {
{format!("{:?}", arg)}
{format!("{}", arg2)}
{str}
}
}
}
```
```rust
println!("{}", Hello { arg: (1, 2), arg2: "arg2", str: "str" });
```
```html
<div>(1, 2)arg2str</div>
```
### Embed Other Templates
```rust
markup::define! {
Add(a: u32, b: u32) {
span { {a + b} }
}
Hello {
{Add { a: 1, b: 2 }}
{Add { a: 3, b: 4 }}
}
}
```
```rust
println!("{}", Hello {});
```
```html
<span>3</span><span>7</span>
```
### If
```rust
markup::define! {
Classify(value: i32) {
{value}
" is "
@if *value < 0 {
"negative"
} else if *value == 0 {
"zero"
} else {
"positive"
}
".\n"
}
Main {
{Classify { value: -42 }}
" "
{Classify { value: 0 }}
" "
{Classify { value: 42 }}
}
}
```
```rust
println!("{}", Main {});
```
```html
-42 is negative.
0 is zero.
42 is positive.
```
### If Let
```rust
markup::define! {
Classify(value: Option<i32>) {
@if let Some(0) = *(value) {
"Some(ZERO)"
} else if let Some(value) = *(value) {
"Some(" {value} ")"
} else {
"None"
}
"\n"
}
Main {
{Classify { value: None }}
{Classify { value: Some(0) }}
{Classify { value: Some(1) }}
}
}
```
```rust
println!("{}", Main {});
```
```html
None
Some(ZERO)
Some(1)
```
### For
```rust
markup::define! {
Main {
@for i in 1..5 {
{i} " * 2 = " {i * 2} ";\n"
}
}
}
```
```rust
println!("{}", Main {});
```
```html
1 * 2 = 2;
2 * 2 = 4;
3 * 2 = 6;
4 * 2 = 8;
```