oparl-types 0.5.0

Type definitions for the OParl protocol
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

// SPDX-FileCopyrightText: Politik im Blick developers
// SPDX-FileCopyrightText: Wolfgang Silbermayr <wolfgang@silbermayr.at>
//
// SPDX-License-Identifier: AGPL-3.0-or-later OR EUPL-1.2

#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Pagination {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub total_elements: Option<usize>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub elements_per_page: Option<usize>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub current_page: Option<usize>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub total_pages: Option<usize>,

    #[serde(default, flatten)]
    pub extensions: serde_json::Map<String, serde_json::Value>,
}

#[cfg(test)]
mod serde_tests {
    use pretty_assertions::assert_eq;
    use serde_json::json;

    use super::Pagination;

    fn example_pagination() -> Pagination {
        Pagination {
            total_elements: Some(50000),
            elements_per_page: Some(100),
            current_page: Some(3),
            total_pages: Some(500),
            extensions: serde_json::Map::new(),
        }
    }

    fn example_pagination_json() -> serde_json::Value {
        json!({
        "totalElements": 50000,
        "elementsPerPage": 100,
        "currentPage": 3,
        "totalPages":500})
    }

    #[test]
    fn serialize() {
        assert_eq!(json!(example_pagination()), example_pagination_json());
    }

    #[test]
    fn deserialize_good() {
        let deserialized: Pagination = serde_json::from_value(example_pagination_json())
            .expect("value must be deserializable as Pagination");
        assert_eq!(deserialized, example_pagination());
    }

    #[test]
    fn serialize_empty() {
        assert_eq!(
            json!(Pagination {
                total_elements: None,
                elements_per_page: None,
                current_page: None,
                total_pages: None,
                extensions: serde_json::Map::new(),
            }),
            json!({}),
        );
    }

    #[test]
    fn deserialize_empty() {
        let deserialized: Pagination =
            serde_json::from_value(json!({})).expect("value must be deserializable as Pagination");
        assert_eq!(
            deserialized,
            Pagination {
                total_elements: None,
                elements_per_page: None,
                current_page: None,
                total_pages: None,
                extensions: serde_json::Map::new(),
            }
        );
    }

    #[test]
    fn deserialize_bad() {
        assert!(serde_json::from_value::<Pagination>(json!("xyzabcd")).is_err());
        assert!(serde_json::from_value::<Pagination>(json!(true)).is_err());
        assert!(serde_json::from_value::<Pagination>(json!(123)).is_err());
    }
}