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
96
97
98
99
100
101
102
103
104
105
106
107
108

use super::*;

impl Ctxt<'_, '_, '_> {
    pub(super) fn comment_array(&mut self, size: Option<usize>) {
        if !self.fmt.auto_comments.array_size {
            return;
        }

        let size = if let Some(size) = size {
            size
        } else {
            return;
        };

        self.out.append_comment(|comment| {
            if comment.is_empty() {
                swrite!(comment, "Must");
            } else {
                swrite!(comment, "; must");
            }

            swrite!(
                comment,
                " contain exactly {} element{}",
                size,
                if size == 1 { "" } else { "s" }
            );
        });
    }
}

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

    fn target<T: Document>(array_size: bool) -> String {
        let fmt = Formatting {
            auto_comments: AutoComments {
                array_size,
                ..Default::default()
            },
            ..Default::default()
        };

        Printer::default().with_formatting(&fmt).print(&T::ty())
    }

    mod when_hint {
        use super::*;

        mod is_disabled {
            use super::*;

            #[test]
            fn then_doesnt_print_hint() {
                assert_doc!(
                    r#"
                    [
                      123,
                      /* ... */
                    ]
                    "#,
                    target::<[usize; 0]>(false)
                );
            }
        }

        mod is_enabled {
            use super::*;

            #[test]
            fn then_prints_hint() {
                assert_doc!(
                    r#"
                    // Must contain exactly 0 elements
                    [
                      123,
                      /* ... */
                    ]
                    "#,
                    target::<[usize; 0]>(true)
                );

                assert_doc!(
                    r#"
                    // Must contain exactly 1 element
                    [
                      123,
                      /* ... */
                    ]
                    "#,
                    target::<[usize; 1]>(true)
                );

                assert_doc!(
                    r#"
                    // Must contain exactly 128 elements
                    [
                      123,
                      /* ... */
                    ]
                    "#,
                    target::<[usize; 128]>(true)
                );
            }
        }
    }
}