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

use std::fmt::Display;

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

use super::Image;

/// # Images
///
/// One or more [Image]'s separated by [EOL](type@crate::lexer::TokenKind::Eol). There is
/// no 1:1 match for that in HTML.
///
/// Example:
///
/// ```text
/// ![alt](src)
/// ![alt](src)
/// ```
///
/// HTML equivalent:
///
/// ```html
/// <div class="images">
///     <img src="url" alt="alt"/>
///     <img src="url" alt="alt"/>
/// </div>
/// ```
///
/// # Round-trip invariant
///
/// A single-element `Images` has no grammatical form distinct from a lone
/// [`Image`] — both serialize to `![alt](src)`. Constructing
/// `Images::new(vec![image])` (with fewer than two images) is permitted for
/// now but will not round-trip (it will parse back as `Image`). A future
/// breaking change is expected to reject bodies shorter than two at
/// construction.

#[derive(Debug, PartialEq, Clone, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Images {
    pub body: Vec<Image>,
}

impl Images {
    pub fn new(body: Vec<Image>) -> Self {
        Self { body }
    }
}

impl Display for Images {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            self.body
                .iter()
                .map(|image| image.to_string())
                .collect::<Vec<_>>()
                .join("\n")
        )
    }
}

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

    #[test]
    fn images() {
        let images = Images::new(vec![Image::new("alt", "src"), Image::new("alt", "src")]);
        assert_eq!(images.to_string(), "![alt](src)\n![alt](src)");
    }
}