markdown-extract 0.1.0-alpha

Extract sections of a markdown file.
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

/// A section within a markdown document
#[allow(dead_code)]
#[derive(Debug, Clone)]
pub struct Section {
    /// Section depth. In markdown, legal values range from 1 to 6, although this implementation
    /// technically allows more.
    pub level: u8,

    /// Title of section
    pub title: String,

    /// Raw markdown body.
    /// Does not include any child sections. See the `children` property for child content.
    pub body: String,

    /// An optional pointer to a parent section.
    /// This property should always be `Some`, unless the section is located at the root of the
    /// document.
    pub parent: Option<usize>,

    /// A vector of child sections
    pub children: Vec<usize>,
}

impl Section {
    /// Construct a new section
    pub fn new() -> Section {
        Section {
            level: 0,
            title: String::new(),
            body: String::new(),
            parent: None,
            children: Vec::new(),
        }
    }

    /// Appends the given line to the section's body
    pub fn append_to_body(&mut self, line: String) {
        self.body.push_str(&line);
        self.body.push('\n');
    }

    /// Add a child to this section.
    pub fn add_child(&mut self, child: usize) {
        self.children.push(child);
    }
}

/// A collection of sections from a markdown document
pub type Document = Vec<Section>;