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
88
89
90
91
92
93

use std::fmt::Display;

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

/// # Strikethrough
///
/// Any token except [Terminator](type@crate::lexer::TokenKind::Terminator) surrounded by
/// [Tilde](type@crate::lexer::TokenKind::Tilde) of length 2.
///
/// Example:
///
/// ```text
/// ~~Strikethrough can contain any token
/// even EOL~~
/// ```
///
/// HTML equivalent:
///
/// ```html
/// <s>Strikethrough can contain any token
/// even EOL</s>
/// ```
///
/// # Round-trip invariant
///
/// An empty body has no meaningful semantic or visual interpretation and its
/// serialization (`~~~~`) does not round-trip. Constructing
/// `Strikethrough::new("")` is permitted for now but should not be relied on —
/// a future breaking change is expected to reject empty bodies at construction.

#[derive(Debug, PartialEq, Clone, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Strikethrough(pub String);

impl Strikethrough {
    pub fn new<Body: Into<String>>(body: Body) -> Self {
        Strikethrough(body.into())
    }
}

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

impl From<String> for Strikethrough {
    fn from(value: String) -> Self {
        Strikethrough(value)
    }
}

#[cfg(test)]
mod tests {
    use crate::nodes::Strikethrough;

    #[test]
    fn strikethrough() {
        let strikethrough: Strikethrough = "Strikethrough can contain any token even \n"
            .to_string()
            .into();
        assert_eq!(
            strikethrough.to_string(),
            "~~Strikethrough can contain any token even \n~~"
        );
    }

    #[test]
    fn strikethrough_with_tilde() {
        let strikethrough = Strikethrough::new("Strikethrough can contain any token even ~~");
        assert_eq!(
            strikethrough.to_string(),
            "~~Strikethrough can contain any token even \\~\\~~~"
        );
    }

    #[test]
    fn strikethrough_with_terminator() {
        let strikethrough = Strikethrough::new("Strikethrough with terminator\n\n");
        assert_eq!(
            strikethrough.to_string(),
            "~~Strikethrough with terminator\\\n\n~~"
        );
    }
}