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

use crate::*;

/// Determines how values should get displayed.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub enum ValuesStyle {
    /// Displays values _outside_ of objects, as comments:
    ///
    /// ```
    /// use doku::Document;
    /// use serde::Serialize;
    ///
    /// #[derive(Serialize, Document)]
    /// struct Person {
    ///     /// First name
    ///     name: String,
    /// }
    ///
    /// let fmt = doku::json::Formatting {
    ///     values_style: doku::json::ValuesStyle::Comment(
    ///         "Default value: ".to_string(),
    ///     ),
    ///     ..Default::default()
    /// };
    ///
    /// let val = Person {
    ///     name: "Janet".to_string(),
    /// };
    ///
    /// let doc = doku::to_json_fmt_val(&fmt, &val);
    ///
    /// doku::assert_doc!(r#"
    ///   {
    ///     // First name
    ///     // Default value: "Janet"
    ///     "name": "string"
    ///   }
    /// "#, doc);
    /// ```
    Comment(String),

    /// Displays values _inside_ of objects, as fields:
    ///
    /// ```
    /// use doku::Document;
    /// use serde::Serialize;
    ///
    /// #[derive(Serialize, Document)]
    /// struct Person {
    ///     /// First name
    ///     name: String,
    /// }
    ///
    /// let fmt = doku::json::Formatting {
    ///     values_style: doku::json::ValuesStyle::Field,
    ///     ..Default::default()
    /// };
    ///
    /// let val = Person {
    ///     name: "Janet".to_string(),
    /// };
    ///
    /// let doc = doku::to_json_fmt_val(&fmt, &val);
    ///
    /// doku::assert_doc!(r#"
    ///   {
    ///     // First name
    ///     "name": "Janet"
    ///   }
    /// "#, doc);
    /// ```
    Field,
}

impl Default for ValuesStyle {
    fn default() -> Self {
        Self::Field
    }
}