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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use super::*;

pub(super) fn print<'ty>(
    ctxt: &mut Ctxt<'_, 'ty, '_>,
    tag: Tag,
    variants: &[&'ty Variant],
) {
    let indent = ctxt.should_indent()
        && ctxt.parent.map_or(false, |parent| {
            matches!(parent.kind, TypeKind::Struct { .. })
        });

    if indent {
        ctxt.out.ln();
        ctxt.out.inc_indent();
    }

    for (variant_idx, variant) in variants.iter().enumerate() {
        if ctxt.is_table() {
            print_table_variant(ctxt, tag, variant_idx, variant);
        } else {
            print_scalar_variant(ctxt, tag, variant_idx, variant);
        }
    }

    if indent {
        ctxt.out.dec_indent();
    }
}

fn print_table_variant<'ty>(
    ctxt: &mut Ctxt<'_, 'ty, '_>,
    tag: Tag,
    variant_idx: usize,
    variant: &'ty Variant,
) {
    if variant_idx > 0 {
        ctxt.out.write("\n# or\n\n");
    }

    if let Some(comment) = variant.comment {
        ctxt.out.writeln_comment(comment);
    }

    print_variant(ctxt, tag, variant);
}

fn print_scalar_variant<'ty>(
    ctxt: &mut Ctxt<'_, 'ty, '_>,
    tag: Tag,
    variant_idx: usize,
    variant: &'ty Variant,
) {
    if variant_idx > 0 {
        ctxt.out.write("\n# or\n");
    }

    ctxt.out.inc_indent();
    if let Some(comment) = variant.comment {
        ctxt.out.ln();
        ctxt.out.writeln_comment(comment);
    }

    print_variant(ctxt, tag, variant);
    ctxt.out.dec_indent();
}

fn print_variant<'ty>(
    ctxt: &mut Ctxt<'_, 'ty, '_>,
    tag: Tag,
    variant: &'ty Variant,
) {
    match tag {
        Tag::Adjacent { tag, content } => {
            ctxt.out.inc_indent();
            ctxt.out.write_key_and_separator(tag);
            ctxt.out.write(format!(r#""{}""#, variant.id));
            ctxt.out.ln();

            if !matches!(variant.fields, Fields::Unit) {
                ctxt.print_child_name(content, variant.fields.is_table());
                ctxt.print_fields(&variant.fields, None, true);
                ctxt.out.ln();
            }

            ctxt.out.dec_indent();
        }

        Tag::Internal { tag } => {
            ctxt.out.inc_indent();
            ctxt.out.write_key_and_separator(tag);
            ctxt.out.write(format!(r#""{}""#, variant.id));
            ctxt.out.ln();

            match &variant.fields {
                Fields::Named { .. } => {
                    ctxt.nested().with_flat().print_fields(
                        &variant.fields,
                        None,
                        true,
                    );

                    ctxt.out.ln();
                }
                Fields::Unnamed { .. } => {
                    panic!("Internally tagged unnamed variants are unsupported in TOML")
                }
                Fields::Unit => {}
            }

            ctxt.out.dec_indent();
        }

        Tag::External => match variant.fields {
            Fields::Named { .. } | Fields::Unnamed { .. } => {
                ctxt.out.inc_indent();
                ctxt.print_child_name(variant.id, variant.fields.is_table());
                ctxt.print_fields(&variant.fields, None, false);
                ctxt.out.ln();
                ctxt.out.dec_indent();
            }

            Fields::Unit => {
                ctxt.out.write(format!(r#""{}""#, variant.id));
            }
        },

        Tag::None => match variant.fields {
            Fields::Named { .. } | Fields::Unnamed { .. } => {
                if !variant.fields.is_table() {
                    panic!("Untagged scalar variants are unsupported in TOML")
                }

                ctxt.out.inc_indent();
                ctxt.print_fields(&variant.fields, None, false);
                ctxt.out.ln();
                ctxt.out.dec_indent();
            }

            Fields::Unit => {
                panic!("Untagged unit variants are unsupported in TOML")
            }
        },
    }
}