askama_escape 0.15.6

HTML escaping, extracted from Askama
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(not(docsrs), no_std)]
#![deny(elided_lifetimes_in_paths)]
#![deny(unreachable_pub)]
#![deny(missing_docs)]
#![doc = include_str!("../README.md")]

use core::fmt;

mod ascii_str;
mod html;

/// Escape for HTML or XML.
#[derive(Debug, Clone, Copy, Default)]
pub struct Html;

/// Escape for plain text, i.e. pass through unchanged.
#[derive(Debug, Clone, Copy, Default)]
pub struct Text;

/// An escaper for some context, e.g. [`Html`].
pub trait Escaper {
    /// Escaped the input string `string` into `dest`
    fn write_escaped<W: fmt::Write>(&self, dest: W, string: &str) -> fmt::Result;
}

impl Escaper for Html {
    #[inline]
    fn write_escaped<W: fmt::Write>(&self, dest: W, string: &str) -> fmt::Result {
        html::write_escaped_str(dest, string)
    }
}

impl Escaper for Text {
    #[inline]
    fn write_escaped<W: fmt::Write>(&self, mut dest: W, string: &str) -> fmt::Result {
        dest.write_str(string)
    }
}

/// The return type of [`escape()`].
///
/// ## Example
///
/// ```rust
/// use askama_escape::{escape, Escaped, Html};
///
/// let escaped: Escaped<'_, _> = escape("<script>alert('Hello & bye!')</script>", Html);
/// assert_eq!(
///     escaped.to_string(),
///     "&#60;script&#62;alert(&#39;Hello &#38; bye!&#39;)&#60;/script&#62;",
/// );
/// ```
#[derive(Debug, Clone, Copy)]
pub struct Escaped<'a, E: Escaper> {
    string: &'a str,
    escaper: E,
}

impl<E: Escaper> fmt::Display for Escaped<'_, E> {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.escaper.write_escaped(f, self.string)
    }
}

/// Safely wrap a `string` with some [`escaper`][Escaper] e.g. for the use in [`Html`].
///
/// ## Example
///
/// ```rust
/// use askama_escape::{escape, Html};
///
/// assert_eq!(
///     escape("<script>alert('Hello & bye!')</script>", Html).to_string(),
///     "&#60;script&#62;alert(&#39;Hello &#38; bye!&#39;)&#60;/script&#62;",
/// );
/// ```
#[inline]
pub fn escape<E: Escaper>(string: &str, escaper: E) -> Escaped<'_, E> {
    Escaped { string, escaper }
}

/// HTML/XML escape a string `str` into `dest`.
///
/// ## Example
///
/// ```rust
/// use askama_escape::escape_html;
///
/// let mut dest = String::new();
/// escape_html(&mut dest, "<script>alert('Hello & bye!')</script>").unwrap();
/// assert_eq!(
///     dest,
///     "&#60;script&#62;alert(&#39;Hello &#38; bye!&#39;)&#60;/script&#62;",
/// );
/// ```
#[inline]
pub fn escape_html(dest: impl fmt::Write, src: &str) -> fmt::Result {
    html::write_escaped_str(dest, src)
}

/// HTML/XML escape a character `c` into `dest`.
///
/// ## Example
///
/// ```rust
/// use askama_escape::escape_html_char;
///
/// let mut dest = String::new();
/// escape_html_char(&mut dest, '&').unwrap();
/// assert_eq!(dest, "&#38;");
/// ```
pub fn escape_html_char(dest: impl fmt::Write, c: char) -> fmt::Result {
    html::write_escaped_char(dest, c)
}

#[cfg(test)]
mod tests {
    extern crate std;

    use std::string::ToString;

    use super::*;

    #[test]
    fn test_escape() {
        assert_eq!(escape("", Html).to_string(), "");
        assert_eq!(escape("<&>", Html).to_string(), "&#60;&#38;&#62;");
        assert_eq!(escape("bla&", Html).to_string(), "bla&#38;");
        assert_eq!(escape("<foo", Html).to_string(), "&#60;foo");
        assert_eq!(escape("bla&h", Html).to_string(), "bla&#38;h");
    }
}