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

use crate::*;

/// Determines the indenting style.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct IndentStyle {
    /// How many spaces to use to indicate that objects are nested:
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     friends: [String; 3],
    /// }
    ///
    /// let fmt = doku::toml::Formatting {
    ///     indent_style: doku::toml::IndentStyle {
    ///         size: 8,
    ///         ..Default::default()
    ///     },
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_toml_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   ## Must contain exactly 3 elements
    ///   friends = [
    ///           "string",
    ///           ## ...
    ///   ]
    /// "#, doc);
    /// ```
    pub size: usize,

    /// Whether table fields should be indented:
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     name: String,
    ///     address: Address,
    /// }
    ///
    /// #[derive(Document)]
    /// struct Address {
    ///     street: String,
    ///     number: u32
    /// }
    ///
    /// let fmt = doku::toml::Formatting {
    ///     indent_style: doku::toml::IndentStyle {
    ///         indent_table_fields: true,
    ///         ..Default::default()
    ///     },
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_toml_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   name = "string"
    ///
    ///   [address]
    ///     street = "string"
    ///     number = 123
    /// "#, doc);
    /// ```
    pub indent_table_fields: bool,
}

impl Default for IndentStyle {
    fn default() -> Self {
        Self {
            size: 2,
            indent_table_fields: false,
        }
    }
}