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

use super::DokuMetas;
use crate::prelude::*;
use darling::FromMeta;

/// Models the `#[doku]` attribute for fields:
///
/// ```ignore
/// struct Foo {
///     #[doku(as = "Zar")]
///     field: Bar,
/// }
/// ````
#[derive(Clone, Debug, Default, FromMeta)]
pub struct DokuField {
    #[darling(default, rename = "as")]
    pub as_: Option<syn::LitStr>,

    #[darling(default, rename = "example", multiple)]
    pub examples: Vec<syn::LitStr>,

    #[darling(default, rename = "meta", multiple)]
    pub metas: Vec<DokuMetas>,

    #[darling(default)]
    pub literal_example: Option<syn::LitStr>,

    #[darling(default)]
    pub flatten: Option<bool>,

    #[darling(default)]
    pub rename: Option<syn::LitStr>,

    #[darling(default)]
    pub skip: Option<bool>,

    #[darling(default)]
    pub tag: Option<syn::LitStr>,
}

impl DokuField {
    pub fn from_ast(attrs: &[syn::Attribute]) -> Result<Self> {
        attrs::from_ast(attrs, "doku")
            .map(|attrs| attrs.fold(Self::default(), Self::merge))
    }

    fn merge(self, other: Self) -> Self {
        let examples =
            self.examples.into_iter().chain(other.examples).collect();

        let metas = self.metas.into_iter().chain(other.metas).collect();

        Self {
            as_: other.as_.or(self.as_),
            examples,
            metas,
            literal_example: other.literal_example.or(self.literal_example),
            flatten: other.flatten.or(self.flatten),
            rename: other.rename.or(self.rename),
            skip: other.skip.or(self.skip),
            tag: other.tag.or(self.tag),
        }
    }
}