#xml #html #format

format_xml

Minimal compiletime templating for XML in Rust!

5 releases

✓ Uses Rust 2018 edition

0.1.4 Sep 9, 2019
0.1.3 Sep 8, 2019
0.1.2 Aug 26, 2019
0.1.1 Aug 22, 2019
0.1.0 Aug 16, 2019

#27 in Template engine

30 downloads per month
Used in 1 crate

MIT license

33KB
336 lines

Format XML Templating

MIT License crates.io docs.rs

Minimal compiletime templating for XML in Rust!

The format_xml! macro accepts an XML-like syntax and transforms it into a format_args! invocation. We say XML-like because due to limitations of the macro system some concessions had to be made, see the examples below.

Features of this crate include providing the value to be formatted inline in the formatting braces and control flow for conditionally formatting all in one simple package with zero dependencies!

In your Cargo.toml add:

[dependencies]
format_xml = "0.1"

Examples

Basic usage

let point = (20, 30);
let name = "World";

format_xml! {
	<svg width="200" height="200">
		<line x1="0" y1="0" x2={point.0} y2={point.1} stroke="black" stroke-width="2" />
		<text x={point.1} y={point.0}>"Hello '" {name} "'!"</text>
	</svg>
}.to_string()

The resulting string is <svg width="200" height="200"><line x1="0" y1="0" x2="20" y2="30" stroke="black" stroke-width="2" /><text x="30" y="20">Hello 'World!'</text></svg>.

Note how the expression values to be formatted are inlined in the formatting braces.

Formatting specifiers

let value = 42;

format_xml! {
	<span data-value={value}>{value;#x?}</span>
}.to_string()

The resulting string is <span data-value="42">0x2a</span>.

Due to limitations of macros by example, a semicolon is used to separate the value from the formatting specifiers. The rules for the specifiers are exactly the same as the standard library of Rust.

Supported tags

format_xml! {
	<!doctype html>
	<?xml version="1.0" encoding="UTF-8"?>
	<tag-name></tag-name>
	<ns:self-closing-tag />
	<!-- "comment" -->
	<![CDATA["cdata"]]>
}.to_string()

The resulting string is <!doctype html><?xml version="1.0" encoding="UTF-8"?><tag-name></tag-name><ns:self-closing-tag /><!-- comment --><![CDATA[cdata]]>.

Control flow

let switch = true;
let opt = Some("World");
let result: Result<f32, i32> = Err(13);

format_xml! {
	if let Some(name) = (opt) {
		<h1>"Hello " {name}</h1>
	}
	else if (switch) {
		<h1>"Hello User"</h1>
	}
	if (switch) {
		match (result) {
			Ok(f) => { <i>{f}</i> }
			Err(i) => { <b>{i}</b> }
		}
		<ul>
		for i in (1..=5) {
			let times_five = i * 5;
			<li>{i}"*5="{times_five}</li>
		}
		</ul>
	}
	else {
		<p>"No contents"</p>
	}
}.to_string()

The resulting string is <h1>Hello World</h1><b>13</b><ul><li>1*5=5</li><li>2*5=10</li><li>3*5=15</li><li>4*5=20</li><li>5*5=25</li></ul>.

Control flow are currently only supported outside tags. They are not supported in attributes. The expressions for if and for must be surrounded with parentheses due to macro by example limitations.

Specialised attribute syntax

let has_a = true;
let has_b = false;
let make_red = true;

format_xml! {
	<div class=["class-a": has_a, "class-b": has_b]>
		<span style=["color: red;": make_red]></span>
		<p data-attr=("has_a:"{has_a}",has_b:"{has_b})></p>
		<p data-fmt=|f| { f.write_str(if make_red { "MAKE_RED" } else { "" }) }></p>
	</div>
}.to_string()

The resulting string is <div class="class-a "><span style="color: red; "></span><p data-attr="has_a:true,has_b:false"></p><p data-fmt="MAKE_RED"></p></div>.

Dedicated syntax for fixed set of space delimited attribute values where each element can be conditionally included. This is specifically designed to work with the style and class attributes of html.

If attributes require more advanced formatting, the template! syntax is available by wrapping the value in parentheses. For even more power closure syntax is available to write custom formatting code. The curly braces are required.

Limitations

This crate is implemented with standard macros by example (macro_rules!). Because of this there are various limitations:

  • It is not possible to check whether tags are closed by the appropriate closing tag. This crate will happily accept <open></close>. It does enforce more simple lexical rules such as rejecting </tag/>.

  • Escaping of <, &, > and " is not automatic. You can trivially break the structure by including these characters in either the formatting string or formatted values. Avoid untrusted input!

  • The formatting specifiers are separated from its value by a semicolon instead of a colon.

  • The compiler may complain about macro expansion recursion limit being reached, simply apply the suggested fix and increase the limit. This crate implements a 'tt muncher' which are known to hit these limits.

  • Text nodes must be valid Rust literals. Bare words are not supported.

License

Licensed under MIT License, see license.txt.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.

No runtime deps