yamd 0.19.0

Yet Another Markdown Document (flavour)
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

use std::fmt::Display;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// # Code
///
/// Starts with [Backtick](type@crate::lexer::TokenKind::Backtick) of length 3.
///
/// [Lang](Code::lang) is every token except [Terminator](type@crate::lexer::TokenKind::Terminator)
/// between [Backtick](type@crate::lexer::TokenKind::Backtick) of length 3 and
/// [EOL](type@crate::lexer::TokenKind::Eol).
///
/// [Code](Code::code) is every token until [Backtick](type@crate::lexer::TokenKind::Backtick) of
/// length 3.
///
/// Example:
///
/// ~~~text
/// ```rust
/// let a = 42;
/// ```
/// ~~~
///
/// HTML equivalent:
///
/// ```html
/// <pre><code class="rust">let a = 42;</code></pre>
/// ```

#[derive(Debug, PartialEq, Clone, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Code {
    pub lang: String,
    pub code: String,
}

impl Code {
    pub fn new<S: Into<String>>(lang: S, code: S) -> Self {
        let code = code.into();
        let code = code.trim_end_matches('\n').to_owned();
        Self {
            lang: lang.into(),
            code,
        }
    }
}

impl Display for Code {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "```{}\n{}\n```",
            self.lang
                .replace("\\", "\\\\")
                .replace("`", "\\`")
                .replace("\n", "\\\n"),
            self.code.replace("\\", "\\\\").replace("```", "\\```")
        )
    }
}

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

    #[test]
    fn code() {
        let code = Code::new("rust", "let a = 42;");
        assert_eq!(code.to_string(), "```rust\nlet a = 42;\n```");
    }

    #[test]
    fn code_with_backtick() {
        let code = Code::new("rust", "let a = 42;\nlet ```b` = 43;");
        assert_eq!(
            code.to_string(),
            "```rust\nlet a = 42;\nlet \\```b` = 43;\n```"
        );
    }

    #[test]
    fn language_with_eol() {
        let code = Code::new("rust\n\n", "let a = 42;");
        assert_eq!(code.to_string(), "```rust\\\n\\\n\nlet a = 42;\n```");
    }
}