html_escape/
lib.rs

1/*!
2# HTML Escape
3
4This library is for encoding/escaping special characters in HTML and decoding/unescaping HTML entities as well.
5
6## Usage
7
8### Encoding
9
10This crate provides some `encode_*` functions to encode HTML text in different situations.
11
12For 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.
13
14```rust
15assert_eq!("a &gt; b &amp;&amp; a &lt; c", html_escape::encode_text("a > b && a < c"));
16```
17
18The functions suffixed with `_to_writer`, `_to_vec` or `_to_string` are useful to generate HTML.
19
20```rust
21let mut html = String::from("<input value=");
22assert_eq!("Hello&#x20;world&#x21;", html_escape::encode_unquoted_attribute_to_string("Hello world!", &mut html));
23html.push_str(" placeholder=\"");
24assert_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));
25html.push_str("\"/><script>alert('");
26assert_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));
27html.push_str("');</script>");
28
29assert_eq!("<input value=Hello&#x20;world&#x21; placeholder=\"The default value is &quot;Hello world!&quot;.\"/><script>alert(\'<script>\\\'s end tag is <\\/script>\');</script>", html);
30```
31
32### Decoding
33
34```rust
35assert_eq!("Hello world!", html_escape::decode_html_entities("Hello&#x20;world&#x21;"));
36```
37
38```rust
39assert_eq!("alert('<script></script>');", html_escape::decode_script(r"alert('<script><\/script>');"));
40```
41
42## No Std
43
44Disable the default features to compile this crate without std.
45
46```toml
47[dependencies.html-escape]
48version = "*"
49default-features = false
50```
51
52## Benchmark
53
54```bash
55cargo bench
56```
57*/
58
59#![cfg_attr(not(feature = "std"), no_std)]
60
61extern crate alloc;
62
63mod decode;
64mod encode;
65mod functions;
66
67pub use decode::*;
68pub use encode::*;