mdbook-core 0.5.2

The base support library for mdbook, intended for internal use only
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

//! Utilities for dealing with HTML.

use std::borrow::Cow;

/// Escape characters to make it safe for an HTML string.
pub fn escape_html_attribute(text: &str) -> Cow<'_, str> {
    let needs_escape: &[char] = &['<', '>', '\'', '"', '\\', '&'];
    let mut s = text;
    let mut output = String::new();
    while let Some(next) = s.find(needs_escape) {
        output.push_str(&s[..next]);
        match s.as_bytes()[next] {
            b'<' => output.push_str("&lt;"),
            b'>' => output.push_str("&gt;"),
            b'\'' => output.push_str("&#39;"),
            b'"' => output.push_str("&quot;"),
            b'\\' => output.push_str("&#92;"),
            b'&' => output.push_str("&amp;"),
            _ => unreachable!(),
        }
        s = &s[next + 1..];
    }
    if output.is_empty() {
        Cow::Borrowed(text)
    } else {
        output.push_str(s);
        Cow::Owned(output)
    }
}

/// Escape `<`, `>`, and '&' for HTML.
pub fn escape_html(text: &str) -> Cow<'_, str> {
    let needs_escape: &[char] = &['<', '>', '&'];
    let mut s = text;
    let mut output = String::new();
    while let Some(next) = s.find(needs_escape) {
        output.push_str(&s[..next]);
        match s.as_bytes()[next] {
            b'<' => output.push_str("&lt;"),
            b'>' => output.push_str("&gt;"),
            b'&' => output.push_str("&amp;"),
            _ => unreachable!(),
        }
        s = &s[next + 1..];
    }
    if output.is_empty() {
        Cow::Borrowed(text)
    } else {
        output.push_str(s);
        Cow::Owned(output)
    }
}

#[test]
fn attributes_are_escaped() {
    assert_eq!(escape_html_attribute(""), "");
    assert_eq!(escape_html_attribute("<"), "&lt;");
    assert_eq!(escape_html_attribute(">"), "&gt;");
    assert_eq!(escape_html_attribute("<>"), "&lt;&gt;");
    assert_eq!(escape_html_attribute("<test>"), "&lt;test&gt;");
    assert_eq!(escape_html_attribute("a<test>b"), "a&lt;test&gt;b");
    assert_eq!(escape_html_attribute("'"), "&#39;");
    assert_eq!(escape_html_attribute("\\"), "&#92;");
    assert_eq!(escape_html_attribute("&"), "&amp;");
}

#[test]
fn html_is_escaped() {
    assert_eq!(escape_html(""), "");
    assert_eq!(escape_html("<"), "&lt;");
    assert_eq!(escape_html(">"), "&gt;");
    assert_eq!(escape_html("&"), "&amp;");
    assert_eq!(escape_html("<>"), "&lt;&gt;");
    assert_eq!(escape_html("<test>"), "&lt;test&gt;");
    assert_eq!(escape_html("a<test>b"), "a&lt;test&gt;b");
    assert_eq!(escape_html("'"), "'");
    assert_eq!(escape_html("\\"), "\\");
}