doku 0.21.1

A framework for documenting Rust data structures
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
94
95

pub mod layouts;

use crate::printers::prelude::*;
use std::collections::BTreeMap;

pub trait Output<'a> {
    fn comment_separator(&self) -> &str;
    fn lines(&'a self) -> Lines<'a>;
}

pub struct Line<'a> {
    pub id: usize,
    pub indent: usize,
    pub body: &'a str,
    pub comments: &'a [String],
}

impl Line<'_> {
    pub fn len(&self) -> usize {
        self.indent + self.body.chars().count()
    }
}

pub struct Lines<'a> {
    lines: &'a [String],
    indent_size: usize,
    indents: &'a BTreeMap<usize, usize>,
    comments: &'a BTreeMap<usize, Vec<String>>,
}

impl<'a> Lines<'a> {
    pub fn new(
        lines: &'a [String],
        indent_size: usize,
        indents: &'a BTreeMap<usize, usize>,
        comments: &'a BTreeMap<usize, Vec<String>>,
    ) -> Self {
        Self {
            lines,
            indent_size,
            indents,
            comments,
        }
    }
}

impl<'a> IntoIterator for Lines<'a> {
    type Item = Line<'a>;

    type IntoIter = LinesIter<'a>;

    fn into_iter(self) -> Self::IntoIter {
        LinesIter {
            lines: self,
            index: 0,
        }
    }
}

pub struct LinesIter<'a> {
    lines: Lines<'a>,
    index: usize,
}

impl<'a> Iterator for LinesIter<'a> {
    type Item = Line<'a>;

    fn next(&mut self) -> Option<Self::Item> {
        let result = self.lines.lines.get(self.index).map(|body| {
            let indent = self.lines.indent_size
                * self
                    .lines
                    .indents
                    .get(&self.index)
                    .copied()
                    .unwrap_or_default();

            let comments = self
                .lines
                .comments
                .get(&self.index)
                .map(|comments| &comments[..])
                .unwrap_or(&[]);

            Line {
                id: self.index,
                indent,
                body,
                comments,
            }
        });
        self.index += 1;
        result
    }
}