doku-derive 0.21.2

A framework for building documentation (internal macro)
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

use super::*;

pub fn expand_variant(
    variant: &syn::Variant,
    rename_variants: RenameRule,
) -> Result<TokenStream2> {
    let syn::Variant {
        attrs,
        ident,
        fields,
        ..
    } = variant;

    let doku = attrs::DokuVariant::from_ast(attrs)?;
    let serde = attrs::SerdeVariant::from_ast(attrs)?;

    let ident = rename_variants.apply_to_variant(&ident.to_string());

    let rename_fields =
        doku.rename_all.or(serde.rename_all).unwrap_or_default();

    let mut variant = Variant {
        id: quote! { #ident },
        title: quote! { #ident },
        comment: quote! { None },
        fields: expand_fields(fields, rename_fields)?,
        serializable: true,
        deserializable: true,
        aliases: quote! { &[] },
    };

    variant.add_doc_attrs(attrs);
    variant.add_serde_attrs(attrs)?;
    variant.add_doku_attrs(attrs)?;

    Ok(variant.render())
}

struct Variant {
    id: TokenStream2,
    title: TokenStream2,
    comment: TokenStream2,
    fields: TokenStream2,
    serializable: bool,
    deserializable: bool,
    aliases: TokenStream2,
}

impl Variant {
    fn add_doc_attrs(&mut self, attrs: &[syn::Attribute]) {
        if let Some(comment) = attrs::Doc::from_ast(attrs).comment {
            self.comment = quote! { Some(#comment) };
        }
    }

    fn add_serde_attrs(&mut self, attrs: &[syn::Attribute]) -> Result<()> {
        let attrs::SerdeVariant {
            alias,
            deserialize_with: _,
            other: _,
            rename,
            rename_all: _,
            serialize_with: _,
            skip,
            skip_deserializing,
            skip_serializing,
            with: _,
        } = attrs::SerdeVariant::from_ast(attrs)?;

        if let Some(val) = rename {
            self.id = quote_spanned! { val.span() => #val };
        }

        if let Some(val) = skip {
            self.serializable = !val;
            self.deserializable = !val;
        }

        if !alias.is_empty() {
            self.aliases = quote! { &[#(#alias),*] }
        }

        if let Some(val) = skip_deserializing {
            self.deserializable = !val;
        }

        if let Some(val) = skip_serializing {
            self.serializable = !val;
        }

        Ok(())
    }

    fn add_doku_attrs(&mut self, attrs: &[syn::Attribute]) -> Result<()> {
        let attrs::DokuVariant {
            rename,
            rename_all: _,
            skip,
        } = attrs::DokuVariant::from_ast(attrs)?;

        if let Some(val) = rename {
            self.id = quote_spanned! { val.span() => #val };
        }

        if let Some(val) = skip {
            self.serializable = !val;
            self.deserializable = !val;
        }

        Ok(())
    }

    fn render(self) -> TokenStream2 {
        let Self {
            id,
            title,
            comment,
            serializable,
            deserializable,
            fields,
            aliases,
        } = self;

        if serializable || deserializable {
            quote! {
                ::doku::Variant {
                    id: #id,
                    title: #title,
                    comment: #comment,
                    serializable: #serializable,
                    deserializable: #deserializable,
                    fields: #fields,
                    aliases: #aliases,
                },
            }
        } else {
            quote! {
                //
            }
        }
    }
}