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

use crate::*;

/// Determines which auto-comments - _hints_, so to say - should get displayed.
///
/// Sometimes Doku is able to automatically infer certain properties about a
/// type and provide a dedicated hint such as "this field is optional". This
/// struct allows to configure whether you'd like for such comments to be
/// printed or not.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct AutoComments {
    /// When set, displays hints for arrays of known sizes:
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     friends: [String; 3],
    /// }
    ///
    /// let fmt = doku::json::Formatting {
    ///     auto_comments: doku::json::AutoComments {
    ///         array_size: true,
    ///         ..Default::default()
    ///     },
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_json_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   {
    ///     // Must contain exactly 3 elements
    ///     "friends": [
    ///       "string",
    ///       /* ... */
    ///     ]
    ///   }
    /// "#, doc);
    /// ```
    pub array_size: bool,

    /// When set, displays hints for optional values:
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     friend: Option<String>,
    /// }
    ///
    /// let fmt = doku::json::Formatting {
    ///     auto_comments: doku::json::AutoComments {
    ///         optional: true,
    ///         ..Default::default()
    ///     },
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_json_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   {
    ///     // Optional
    ///     "friend": "string"
    ///   }
    /// "#, doc);
    /// ```
    pub optional: bool,
}

impl AutoComments {
    pub fn all() -> Self {
        Self {
            array_size: true,
            optional: true,
        }
    }

    pub fn none() -> Self {
        Self {
            array_size: false,
            optional: false,
        }
    }
}

impl Default for AutoComments {
    fn default() -> Self {
        Self::all()
    }
}