markdown-builder 1.0.0

Opinionated Rust crate for programmatically building markdown documents
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

use std::fmt;

/// A checkmark list item.
#[derive(Clone, Debug, Default)]
pub struct CheckmarkItem {
    /// The state of the item.
    ///
    /// `true` if the item is checked, `false` otherwise.
    pub checked: bool,
    /// The text of the checkmark item.
    pub text: String,
}

impl CheckmarkItem {
    /// Creates a new default checkmark item.
    pub fn new() -> Self {
        Self::default()
    }

    /// Creates a mew checkmark item with the given values.
    pub fn from(text: impl Into<String>, checked: bool) -> Self {
        Self {
            text: text.into(),
            checked,
        }
    }
}

impl fmt::Display for CheckmarkItem {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let checkmark = if self.checked { "x" } else { " " };
        write!(f, "[{}] {}", checkmark, self.text)
    }
}

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

    #[test]
    fn test_display() {
        assert_eq!(
            CheckmarkItem::from("Eat spaghetti", false).render(),
            "[ ] Eat spaghetti"
        );
        assert_eq!(
            CheckmarkItem::from("Eat spaghetti", true).render(),
            "[x] Eat spaghetti"
        );
    }
}