struct-metadata 1.3.0

Macros for attaching metadata to structs.
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

#![cfg(test)]

use struct_metadata::{Described, Kind, Entry};


#[derive(Described)]
struct EmptyA;

#[derive(Described)]
struct EmptyB {}

#[test]
fn empty_a() {
    let data = EmptyA::metadata();
    assert_eq!(data.kind, Kind::Struct{ name: "EmptyA", children: vec![]});
    assert_eq!(data.docs, None);
    assert!(data.metadata.is_empty());
}

#[test]
fn empty_b() {
    let data = EmptyB::metadata();
    assert_eq!(data.kind, Kind::Struct{ name: "EmptyB", children: vec![]});
    assert_eq!(data.docs, None);
    assert!(data.metadata.is_empty());
}


#[derive(Described)]
/// Docstring
struct EmptyDocA;

#[derive(Described)]
/// The
///
/// Docstring
struct EmptyDocB {}

#[test]
fn empty_doc_a() {
    let data = EmptyDocA::metadata();
    assert_eq!(data.kind, Kind::Struct{name: "EmptyDocA", children: vec![]});
    assert_eq!(data.docs, Some(vec!["Docstring"]));
    assert!(data.metadata.is_empty());
}

#[test]
fn empty_doc_b() {
    let data = EmptyDocB::metadata();
    assert_eq!(data.kind, Kind::Struct{name: "EmptyDocB", children: vec![]});
    assert_eq!(data.docs, Some(vec!["The", "", "Docstring"]));
    assert!(data.metadata.is_empty());
}


#[derive(Described)]
#[allow(dead_code)]
struct Single(u64);

#[test]
fn single() {
    let data = Single::metadata();
    assert_eq!(data.kind, Kind::Aliased { name: "Single", kind: Box::new(u64::metadata()) });
    assert_eq!(data.docs, None);
    assert!(data.metadata.is_empty());
}

#[derive(Described)]
#[metadata(important: true)]
struct SingleFeatured;

#[derive(Described)]
#[metadata(important: true, cats: "Less than 10")]
struct DoubleFeatured;

#[test]
fn single_featured() {
    let data = SingleFeatured::metadata();
    assert_eq!(data.kind, Kind::Struct{ name: "SingleFeatured", children: vec![]});
    assert_eq!(data.docs, None);
    assert_eq!(data.metadata, [("important", "true")].into_iter().collect());
}

#[test]
fn dual_featured() {
    let data = DoubleFeatured::metadata();
    assert_eq!(data.kind, Kind::Struct{ name: "DoubleFeatured", children: vec![]});
    assert_eq!(data.docs, None);
    assert_eq!(data.metadata, [("important", "true"), ("cats", "\"Less than 10\"")].into_iter().collect());
}

#[derive(Described)]
#[metadata(important: true)]
#[allow(dead_code)]
struct SimpleFields {
    /// Name used
    label: u64,

    #[metadata(text: true)]
    description: String,

    /// Are cats allowed here?
    #[metadata(important: true)]
    cats: bool,
}

#[test]
fn simple_fields() {
    let data = SimpleFields::metadata();
    assert_eq!(data.docs, None);
    assert_eq!(data.metadata, [("important", "true")].into_iter().collect());
    assert_eq!(data.kind, Kind::Struct{ name: "SimpleFields", children: vec![
        Entry { label: "label", docs: Some(vec!["Name used"]), has_default: false, metadata: Default::default(), type_info: u64::metadata(), aliases: &["label"] },
        Entry { label: "description", docs: None, has_default: false, metadata: [("text", "true")].into_iter().collect(), type_info: String::metadata(), aliases: &["description"] },
        Entry { label: "cats", docs: Some(vec!["Are cats allowed here?"]), has_default: false, metadata: [("important", "true")].into_iter().collect(), type_info: bool::metadata(), aliases: &["cats"] },
    ]});
}