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

mod auto_comments;
mod comments_style;
mod doc_comments;
mod enums_style;
mod indent_style;
mod layout;
mod spacing;
mod values_style;

pub use self::{
    auto_comments::*, comments_style::*, doc_comments::*, enums_style::*,
    indent_style::*, layout::*, spacing::*, values_style::*,
};

use crate::*;
use std::any;

/// Determines the look & feel of the documentation.
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
#[serde(default)]
pub struct Formatting {
    /// Determines which auto-comments - _hints_, so to say - should get
    /// displayed.
    pub auto_comments: AutoComments,

    /// Determines how comments should get displayed.
    pub comments_style: CommentsStyle,

    /// Determines if doc-comments should get displayed.
    pub doc_comments: DocComments,

    /// Determines how enums should get displayed.
    pub enums_style: EnumsStyle,

    /// Determines the indenting style.
    pub indent_style: IndentStyle,

    /// Determines whether the document should contain one or two columns.
    pub layout: Layout,

    /// Determines the amount of spacing between fields.
    pub spacing: Spacing,

    /// Determines how values should get displayed.
    pub values_style: ValuesStyle,
}

impl Formatting {
    pub(crate) fn customize(&self, metas: impl Iterator<Item = Meta>) -> Self {
        let mut this = serde_json::to_value(self).unwrap();

        for meta in metas {
            if meta.key() == "fmt" {
                this =
                    serde_json::from_str(meta.value()).unwrap_or_else(|err| {
                        panic!(
                            "Not a valid {}: {}",
                            any::type_name::<Self>(),
                            err
                        )
                    });
            } else if let Some(key) = meta.key().strip_prefix("fmt") {
                let key = key.replace('.', "/");

                let this = this.pointer_mut(&key).unwrap_or_else(|| {
                    panic!(
                        "Tried to overwrite a non-existing formatting option: {}",
                        key
                    );
                });

                *this = serde_json::from_str(meta.value())
                    .unwrap_or_else(|err| panic!("Not a valid JSON: {}", err));
            }
        }

        serde_json::from_value(this).unwrap()
    }
}