apple_bloom/v3/
extension.rs

1use std::collections::HashMap;
2use std::fmt;
3
4use serde::de::{MapAccess, Visitor};
5use serde::ser::SerializeMap;
6use serde::{Deserialize, Deserializer, Serialize, Serializer};
7
8/// Contains openapi specification extensions
9/// see https://github.com/OAI/OpenAPI-Specification/blob/aa91a19c43f8a12c02efa42d64794e396473f3b1/versions/3.0.1.md#specificationExtensions
10#[derive(Debug, Default, Eq, PartialEq, Clone)]
11pub struct Extensions(HashMap<String, serde_json::Value>);
12
13impl Extensions {
14    fn add(&mut self, ext_id: String, value: serde_json::Value) {
15        self.0.insert(ext_id, value);
16    }
17
18    /// Fetch extension by name
19    pub fn get(&self, ext_id: &str) -> Option<&serde_json::Value> {
20        self.0.get(ext_id)
21    }
22
23    /// A reference to all the captured extensions
24    pub fn all(&self) -> &HashMap<String, serde_json::Value> {
25        &self.0
26    }
27}
28
29impl<'de> Deserialize<'de> for Extensions {
30    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
31    where
32        D: Deserializer<'de>,
33    {
34        struct ExtensionsVisitor;
35        impl<'de> Visitor<'de> for ExtensionsVisitor {
36            type Value = Extensions;
37
38            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
39                formatter.write_str("struct Extensions")
40            }
41
42            fn visit_map<V>(self, mut map: V) -> Result<Extensions, V::Error>
43            where
44                V: MapAccess<'de>,
45            {
46                let mut extensions = Extensions::default();
47                while let Some(key) = map.next_key::<String>()? {
48                    if key.starts_with("x-") {
49                        extensions.add(key, map.next_value()?);
50                    }
51                }
52                Ok(extensions)
53            }
54        }
55        deserializer.deserialize_map(ExtensionsVisitor)
56    }
57}
58
59impl Serialize for Extensions {
60    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
61    where
62        S: Serializer,
63    {
64        let mut map = serializer.serialize_map(Some(self.0.len()))?;
65        for (k, v) in self.0.clone() {
66            map.serialize_entry(&k, &v)?;
67        }
68        map.end()
69    }
70}
71
72#[cfg(test)]
73mod tests {
74    use serde_json::Value;
75    use serde_test::{assert_tokens, Token};
76
77    use crate::v3::extension::Extensions;
78
79    #[test]
80    fn test_serde_extensions() {
81        let mut extensions = Extensions::default();
82        extensions.add(String::from("x-test"), Value::from("val"));
83        assert_tokens(
84            &extensions,
85            &[
86                Token::Map { len: Some(1) },
87                Token::String("x-test"),
88                Token::String("val"),
89                Token::MapEnd,
90            ],
91        )
92    }
93
94    #[test]
95    fn test_get_extension() {
96        let value = Value::from("val");
97
98        let mut extensions = Extensions::default();
99        extensions.add(String::from("x-test"), value.clone());
100
101        assert_eq!(extensions.get("x-test"), Some(&value));
102    }
103
104    #[test]
105    fn test_all_extensions() {
106        let value = Value::from("val");
107
108        let mut extensions = Extensions::default();
109        extensions.add(String::from("x-test"), value.clone());
110
111        assert_eq!(
112            extensions.all().get_key_value("x-test"),
113            Some((&"x-test".to_string(), &value))
114        );
115    }
116}