This library is for encoding/escaping special characters in HTML and decoding/unescaping HTML entities as well.
This crate provides some encode_* functions to encode HTML text in different situations.
Escaping is context-sensitive.
Use encode_text for text, quoted attribute encoders for quoted attributes, encode_unquoted_attribute for unquoted attributes, and script or style encoders for raw-text elements.
encode_safe is not a context-independent sanitizer.
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.
assert_eq!("a > b && a < 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.
let mut html = String::from("<input value=");
assert_eq!("Hello world!", html_escape::encode_unquoted_attribute_to_string("Hello world!", &mut html));
html.push_str(" placeholder=\"");
assert_eq!("The default value is "Hello world!".", html_escape::encode_double_quoted_attribute_to_string("The default value is \"Hello world!\".", &mut html));
html.push_str("\"/><script>alert('");
assert_eq!(r"<script>\'s end tag is <\/script>", html_escape::encode_script_single_quoted_text_to_string("<script>'s end tag is </script>", &mut html));
html.push_str("');</script>");
assert_eq!("<input value=Hello world! placeholder=\"The default value is "Hello world!".\"/><script>alert(\'<script>\\\'s end tag is <\\/script>\');</script>", html);Decoding accepts exact named and numeric character references ending with ;.
It does not apply legacy semicolonless references or C1 control replacements used by browser tokenizers.
assert_eq!("Hello world!", html_escape::decode_html_entities("Hello world!"));assert_eq!("alert('<script></script>');", html_escape::decode_script(r"alert('<script><\/script>');"));Disable the default features to compile this crate without std.
[dependencies.html-escape]
version = "*"
default-features = falsecargo bench