facet-xml 0.44.0

XML serialization for facet using the new format architecture - successor to facet-xml
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
135
136
137
138
139
140
141
142
143
144
145
146
147

//! XML escaping utilities.

use std::io::{self, Write};

/// Wraps a `Write` and escapes XML special characters as bytes pass through.
pub struct EscapingWriter<'a> {
    inner: &'a mut dyn Write,
    escape_quotes: bool,
}

impl<'a> EscapingWriter<'a> {
    /// Create an escaping writer for text content.
    /// Escapes: `&` `<` `>`
    pub fn text(inner: &'a mut dyn Write) -> Self {
        Self {
            inner,
            escape_quotes: false,
        }
    }

    /// Create an escaping writer for attribute values.
    /// Escapes: `&` `<` `>` `"`
    pub fn attribute(inner: &'a mut dyn Write) -> Self {
        Self {
            inner,
            escape_quotes: true,
        }
    }
}

impl Write for EscapingWriter<'_> {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        for &b in buf {
            match b {
                b'&' => self.inner.write_all(b"&amp;")?,
                b'<' => self.inner.write_all(b"&lt;")?,
                b'>' => self.inner.write_all(b"&gt;")?,
                b'"' if self.escape_quotes => self.inner.write_all(b"&quot;")?,
                _ => self.inner.write_all(&[b])?,
            }
        }
        Ok(buf.len())
    }

    fn flush(&mut self) -> io::Result<()> {
        self.inner.flush()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn text_escapes_amp() {
        let mut buf = Vec::new();
        EscapingWriter::text(&mut buf).write_all(b"a & b").unwrap();
        assert_eq!(buf, b"a &amp; b");
    }

    #[test]
    fn text_escapes_lt() {
        let mut buf = Vec::new();
        EscapingWriter::text(&mut buf).write_all(b"a < b").unwrap();
        assert_eq!(buf, b"a &lt; b");
    }

    #[test]
    fn text_escapes_gt() {
        let mut buf = Vec::new();
        EscapingWriter::text(&mut buf).write_all(b"a > b").unwrap();
        assert_eq!(buf, b"a &gt; b");
    }

    #[test]
    fn text_does_not_escape_quotes() {
        let mut buf = Vec::new();
        EscapingWriter::text(&mut buf)
            .write_all(b"a \"quoted\" b")
            .unwrap();
        assert_eq!(buf, b"a \"quoted\" b");
    }

    #[test]
    fn attribute_escapes_amp() {
        let mut buf = Vec::new();
        EscapingWriter::attribute(&mut buf)
            .write_all(b"a & b")
            .unwrap();
        assert_eq!(buf, b"a &amp; b");
    }

    #[test]
    fn attribute_escapes_lt() {
        let mut buf = Vec::new();
        EscapingWriter::attribute(&mut buf)
            .write_all(b"a < b")
            .unwrap();
        assert_eq!(buf, b"a &lt; b");
    }

    #[test]
    fn attribute_escapes_gt() {
        let mut buf = Vec::new();
        EscapingWriter::attribute(&mut buf)
            .write_all(b"a > b")
            .unwrap();
        assert_eq!(buf, b"a &gt; b");
    }

    #[test]
    fn attribute_escapes_quotes() {
        let mut buf = Vec::new();
        EscapingWriter::attribute(&mut buf)
            .write_all(b"a \"quoted\" b")
            .unwrap();
        assert_eq!(buf, b"a &quot;quoted&quot; b");
    }

    #[test]
    fn escapes_all_special_chars() {
        let mut buf = Vec::new();
        EscapingWriter::attribute(&mut buf)
            .write_all(b"<a & \"b\">")
            .unwrap();
        assert_eq!(buf, b"&lt;a &amp; &quot;b&quot;&gt;");
    }

    #[test]
    fn passthrough_normal_chars() {
        let mut buf = Vec::new();
        EscapingWriter::attribute(&mut buf)
            .write_all(b"hello world 123")
            .unwrap();
        assert_eq!(buf, b"hello world 123");
    }

    #[test]
    fn multiple_writes() {
        let mut buf = Vec::new();
        let mut writer = EscapingWriter::attribute(&mut buf);
        writer.write_all(b"a < ").unwrap();
        writer.write_all(b"b & ").unwrap();
        writer.write_all(b"c").unwrap();
        assert_eq!(buf, b"a &lt; b &amp; c");
    }
}