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

use crate::*;

/// Determines how enums should get displayed.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub enum EnumsStyle {
    /// Displays enum variants as comments:
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     favourite_color: Color,
    /// }
    ///
    /// #[derive(Document)]
    /// enum Color {
    ///     Red,
    ///     Green,
    ///     Blue,
    /// }
    ///
    /// let fmt = doku::json::Formatting {
    ///     enums_style: doku::json::EnumsStyle::Commented,
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_json_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   {
    ///     // Possible variants:
    ///     // - "Red"
    ///     // - "Green"
    ///     // - "Blue"
    ///     "favourite_color": "Red"
    ///   }
    /// "#, doc);
    /// ```
    Commented,

    /// Displays enum variants as separated with a pipe:
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     favourite_color: Color,
    /// }
    ///
    /// #[derive(Document)]
    /// enum Color {
    ///     Red,
    ///     Green,
    ///     Blue,
    /// }
    ///
    /// let fmt = doku::json::Formatting {
    ///     enums_style: doku::json::EnumsStyle::Separated,
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_json_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   {
    ///     "favourite_color": "Red" | "Green" | "Blue"
    ///   }
    /// "#, doc);
    /// ```
    Separated,
}

impl Default for EnumsStyle {
    fn default() -> Self {
        Self::Separated
    }
}