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

type Papers = Vec<Paper>;

struct Paper {
    width: usize,
    height: usize,
}

/// An equivalent of:
///
/// ```
/// struct Paper {
///     size: String,
/// }
/// ```
impl doku::Document for Paper {
    fn ty() -> doku::Type {
        doku::Type::from(doku::TypeKind::Struct {
            fields: doku::Fields::Named {
                fields: vec![(
                    "size",
                    doku::Field {
                        ty: String::ty(),
                        flattened: false,
                        aliases: &[],
                    },
                )],
            },
            transparent: false,
        })
    }
}

impl serde::Serialize for Paper {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        use serde::ser::SerializeStruct;

        let mut s = serializer.serialize_struct("Paper", 1)?;

        let size = match (self.width, self.height) {
            (594, 841) => "A1",
            (420, 594) => "A2",
            _ => panic!("paper machine does brrr"),
        };

        s.serialize_field("size", size)?;
        s.end()
    }
}

fn main() {
    println!("```json");
    println!("{}", doku::to_json::<Papers>());
    println!("```");
    println!();
    println!("```toml");
    println!("{}", doku::to_toml::<Papers>());
    println!("```");
}