HTML Escape

This library is for encoding/escaping special characters in HTML and decoding/unescaping HTML entities as well.

Usage

Encoding

This crate provides some encode_* functions to encode HTML text in different situations.

For example, to put a text between a start tag <foo> and an end tag </foo>, use the encode_text function to escape every &, <, and > in the text.

extern crate html_escape;

assert_eq!("a &gt; b &amp;&amp; a &lt; c", html_escape::encode_text("a > b && a < c"));

The functions suffixed with _to_writer, _to_vec or _to_string are useful to generate HTML.

extern crate html_escape;

let mut html = String::from("<input value=");
assert_eq!("Hello&#x20;world&#x21;", html_escape::encode_unquoted_attribute_to_string("Hello world!", &mut html));
html.push_str(" placeholder=\"");
assert_eq!("The default value is &quot;Hello world!&quot;.", html_escape::encode_double_quoted_attribute_to_string("The default value is \"Hello world!\".", &mut html));
html.push_str("\"/><script>");
assert_eq!(r"alert('<script><\/script>');", html_escape::encode_script_to_string("alert('<script></script>');", &mut html));
html.push_str("</script>");

assert_eq!("<input value=Hello&#x20;world&#x21; placeholder=\"The default value is &quot;Hello world!&quot;.\"/><script>alert('<script><\\/script>');</script>", html);

Decoding

extern crate html_escape;

let mut html = String::from("<input value=");
assert_eq!("Hello world!", html_escape::decode_html_entities("Hello&#x20;world&#x21;"));

extern crate html_escape;

let mut html = String::from("<input value=");
assert_eq!("alert('<script></script>);'", html_escape::decode_script(r"alert('<script><\/script>);'"));

No Std

Disable the default features to compile this crate without std.

[dependencies.html-escape]
version = "*"
default-features = false

Benchmark

cargo bench

Crates.io

https://crates.io/crates/html-escape

Documentation

https://docs.rs/html-escape

License

MIT