Crate html_escape
source · [−]Expand description
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.
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
assert_eq!("Hello world!", html_escape::decode_html_entities("Hello world!"));
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
Statics
The table of HTML named entities ordered by the names.
Functions
Decode html entities in a given string.
Decode html entities in a given string to a mutable String
reference and return the decoded string slice.
Decode html entities in a given string to a mutable Vec<u8>
reference and return the decoded data slice.
Decode html entities in a given string to a writer.
Decode text from the <script>
element.
Decode text from a double quoted text in the <script>
element.
Write text from a double quoted text in the <script>
element to a mutable String
reference and return the encoded string slice.
Write text from a double quoted text in the <script>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text from a double quoted text in the <script>
element to a writer.
Decode text from a quoted text in the <script>
element.
Write text from a quoted text in the <script>
element to a mutable String
reference and return the encoded string slice.
Write text from a quoted text in the <script>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text from a quoted text in the <script>
element to a writer.
Decode text from a single quoted text in the <script>
element.
Write text from a single quoted text in the <script>
element to a mutable String
reference and return the encoded string slice.
Write text from a single quoted text in the <script>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text from a single quoted text in the <script>
element to a writer.
Write text from the <script>
element to a mutable String
reference and return the encoded string slice.
Write text from the <script>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text from the <script>
element to a writer.
Decode text from the <style>
element.
Decode text from a double quoted text in the <style>
element.
Write text from a double quoted text in the <style>
element to a mutable String
reference and return the encoded string slice.
Write text from a double quoted text in the <style>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text from a double quoted text in the <style>
element to a writer.
Decode text from a quoted text in the <style>
element.
Write text from a quoted text in the <style>
element to a mutable String
reference and return the encoded string slice.
Write text from a quoted text in the <style>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text from a quoted text in the <style>
element to a writer.
Decode text from a single quoted text in the <style>
element.
Write text from a single quoted text in the <style>
element to a mutable String
reference and return the encoded string slice.
Write text from a single quoted text in the <style>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text from a single quoted text in the <style>
element to a writer.
Write text from the <style>
element to a mutable String
reference and return the encoded string slice.
Write text from the <style>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text from the <style>
element to a writer.
Encode text used in a double-quoted attribute.
Write text used in a double-quoted attribute to a mutable String
reference and return the encoded string slice.
Write text used in a double-quoted attribute to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used in a double-quoted attribute to a writer.
Encode text used in a quoted attribute.
Write text used in a quoted attribute to a mutable String
reference and return the encoded string slice.
Write text used in a quoted attribute to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used in a quoted attribute to a writer.
Encode text to prevent special characters functioning.
Encode text to prevent special characters functioning and write it to a mutable String
reference and return the encoded string slice.
Encode text to prevent special characters functioning and write it to a mutable Vec<u8>
reference and return the encoded data slice.
Encode text to prevent special characters functioning and write it to a writer.
Encode text used in the <script>
element.
Encode text used in a double quoted text in the <script>
element.
Write text used in a double quoted text in the <script>
element to a mutable String
reference and return the encoded string slice.
Write text used in a double quoted text in the <script>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used in a double quoted text in the <script>
element to a writer.
Encode text used in a quoted text in the <script>
element.
Write text used in a quoted text in the <script>
element to a mutable String
reference and return the encoded string slice.
Write text used in a quoted text in the <script>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used in a quoted text in the <script>
element to a writer.
Encode text used in a single quoted text in the <script>
element.
Write text used in a single quoted text in the <script>
element to a mutable String
reference and return the encoded string slice.
Write text used in a single quoted text in the <script>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used in a single quoted text in the <script>
element to a writer.
Write text used in the <script>
element to a mutable String
reference and return the encoded string slice.
Write text used in the <script>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used in the <script>
element to a writer.
Encode text used in a single-quoted attribute.
Write text used in a single-quoted attribute to a mutable String
reference and return the encoded string slice.
Write text used in a single-quoted attribute to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used in a single-quoted attribute to a writer.
Encode text used in the <style>
element.
Encode text used in a double quoted text in the <style>
element.
Write text used in a double quoted text in the <style>
element to a mutable String
reference and return the encoded string slice.
Write text used in a double quoted text in the <style>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used in a double quoted text in the <style>
element to a writer.
Encode text used in a quoted text in the <style>
element.
Write text used in a quoted text in the <style>
element to a mutable String
reference and return the encoded string slice.
Write text used in a quoted text in the <style>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used in a quoted text in the <style>
element to a writer.
Encode text used in a single quoted text in the <style>
element.
Write text used in a single quoted text in the <style>
element to a mutable String
reference and return the encoded string slice.
Write text used in a single quoted text in the <style>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used in a single quoted text in the <style>
element to a writer.
Write text used in the <style>
element to a mutable String
reference and return the encoded string slice.
Write text used in the <style>
element to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used in the <style>
element to a writer.
Encode text used as regular HTML text.
Encode text used as regular HTML text.
Write text used as regular HTML text to a mutable String
reference and return the encoded string slice.
Write text used as regular HTML text to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used as regular HTML text to a writer.
Write text used as regular HTML text to a mutable String
reference and return the encoded string slice.
Write text used as regular HTML text to a mutable Vec<u8>
reference and return the encoded data slice.
Write text used as regular HTML text to a writer.
Encode text used in an unquoted attribute. Except for alphanumeric characters, escape all characters which are less than 128.
Write text used in an unquoted attribute to a mutable String
reference and return the encoded string slice. Except for alphanumeric characters, escape all characters which are less than 128.
Write text used in an unquoted attribute to a mutable Vec<u8>
reference and return the encoded data slice. Except for alphanumeric characters, escape all characters which are less than 128.
Write text used in an unquoted attribute to a writer. Except for alphanumeric characters, escape all characters which are less than 128.