serde_view 0.1.4

Serialize views of data
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use serde_json::json;
use serde_view::{View, ViewFields};
use std::fmt::Formatter;

#[derive(Clone, Debug, serde_view::View, serde::Serialize, serde::Deserialize)]
pub struct MyRecordDerived {
    some_string: String,
    flag: bool,
    optional_flag: Option<bool>,
}

impl Default for MyRecordDerived {
    fn default() -> Self {
        Self {
            some_string: "Hello World".to_string(),
            flag: true,
            optional_flag: None,
        }
    }
}

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct MyRecord {
    some_string: String,
    flag: bool,
    optional_flag: Option<bool>,
}

impl Default for MyRecord {
    fn default() -> Self {
        Self {
            some_string: "Hello World".to_string(),
            flag: true,
            optional_flag: None,
        }
    }
}

#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
pub enum MyRecordFields {
    SomeString,
    Flag,
    OptionalFlag,
}

impl ViewFields for MyRecordFields {
    fn as_str(&self) -> &'static str {
        match self {
            Self::SomeString => "some_string",
            Self::Flag => "flag",
            Self::OptionalFlag => "optional_flag",
        }
    }

    fn from_str(name: &str) -> Option<Self> {
        Some(match name {
            "some_string" => Self::SomeString,
            "flag" => Self::Flag,
            "optional_flag" => Self::OptionalFlag,
            _ => return None,
        })
    }
}

impl std::fmt::Display for MyRecordFields {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl View for MyRecord {
    type Fields = MyRecordFields;
}

#[test]
fn test_manual() {
    assert_eq!(
        serde_json::to_value(
            MyRecord::default()
                .as_view()
                .with_fields([<MyRecord as View>::Fields::SomeString])
        )
        .unwrap(),
        json!({
            "some_string": "Hello World",
        })
    )
}

#[test]
fn test_derived() {
    assert_eq!(
        serde_json::to_value(
            MyRecordDerived::default()
                .as_view()
                .with_fields([<MyRecordDerived as View>::Fields::SomeString])
        )
        .unwrap(),
        json!({
            "some_string": "Hello World",
        })
    );

    assert_eq!(
        serde_json::to_value(
            MyRecordDerived::default()
                .as_view()
                .with_fields([MyRecordDerivedFields::SomeString])
        )
        .unwrap(),
        json!({
            "some_string": "Hello World",
        })
    );

    assert_eq!(
        serde_json::to_value(
            MyRecordDerived::default()
                .as_view()
                .with_fields("some_string,flag".split(","))
        )
        .unwrap(),
        json!({
            "flag": true,
            "some_string": "Hello World",
        })
    );
}

#[test]
fn test_all() {
    // if no fields are selected, this means: all
    let mut value = MyRecordDerived::default();
    value.optional_flag = Some(false);

    assert_eq!(
        serde_json::to_value(value.as_view()).unwrap(),
        json!({
            "flag": true,
            "some_string": "Hello World",
            "optional_flag": false,
        })
    );
}