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

use super::*;

pub(super) fn sketch(
    ctxt: &mut Ctxt<'_, '_, '_>,
    tag: Tag,
    variants: &[&Variant],
) {
    if let Some(example) = ctxt.first_example() {
        ctxt.out.write(example);
        return;
    }

    let variant = if let Some(variant) = variants.first() {
        variant
    } else {
        ctxt.out.write("null");
        return;
    };

    sketch_variant(ctxt, tag, variant);
}

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

            if !matches!(variant.fields, Fields::Unit) {
                ctxt.print_child_name(content, variant.fields.is_table());
                ctxt.out.write("...");
            }
        }

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

            if !matches!(variant.fields, Fields::Unit) {
                ctxt.out.writeln("...");
            }
        }

        Tag::External => match &variant.fields {
            Fields::Unit => ctxt.out.write(format!(r#""{}""#, variant.id)),
            fields => {
                ctxt.print_child_name(variant.id, fields.is_table());
                ctxt.out.write("...");
            }
        },

        Tag::None => match variant.fields {
            Fields::Named { .. } | Fields::Unnamed { .. } => {
                ctxt.out.write("...");
            }

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