serde_aux/
serde_introspection.rs

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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
use serde::de::{self, Deserialize, Deserializer, Visitor};

/// Gets the serialization names for structs and enums.
///
/// # Example
///
/// ```rust
/// use serde_aux::prelude::*;
///
/// #[derive(serde::Deserialize, Debug)]
/// struct AnotherStruct {
///     #[serde(rename = "a3")]
///     aaa: Option<i64>,
///     #[serde(rename = "b3")]
///     bbb: i128,
///     #[serde(rename = "c3")]
///     ccc: u128,
/// }
/// let fields = serde_introspect::<AnotherStruct>();
/// assert_eq!(fields[0], "a3");
/// assert_eq!(fields[1], "b3");
/// assert_eq!(fields[2], "c3");
///
/// #[derive(serde::Deserialize, Debug)]
/// enum SomeEnum {
///       #[serde(rename = "a")]
///       EnumA,
///       #[serde(rename = "b")]
///       EnumB
/// }
/// let variants = serde_introspect::<SomeEnum>();
/// assert_eq!(variants[0], "a");
/// assert_eq!(variants[1], "b");
/// ```
pub fn serde_introspect<'de, T>() -> &'static [&'static str]
where
    T: Deserialize<'de>,
{
    struct StructFieldsDeserializer<'a> {
        fields: &'a mut Option<&'static [&'static str]>,
    }

    impl<'de, 'a> Deserializer<'de> for StructFieldsDeserializer<'a> {
        type Error = serde::de::value::Error;

        fn deserialize_any<V>(self, _visitor: V) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            Err(de::Error::custom("I'm just here for the fields"))
        }

        fn deserialize_struct<V>(
            self,
            _name: &'static str,
            fields: &'static [&'static str],
            _visitor: V,
        ) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            *self.fields = Some(fields); // get the names of the deserialized fields
            Err(de::Error::custom("I'm just here for the fields"))
        }

        serde::forward_to_deserialize_any! {
            bool i8 i16 i32 i64 u8 u16 u32 u64 f32 f64 char str string bytes
            byte_buf option unit unit_struct newtype_struct seq tuple
            tuple_struct map enum identifier ignored_any
        }
    }

    struct EnumVariantsDeserializer<'a> {
        variants: &'a mut Option<&'static [&'static str]>,
    }

    impl<'de, 'a> Deserializer<'de> for EnumVariantsDeserializer<'a> {
        type Error = serde::de::value::Error;

        fn deserialize_any<V>(self, _visitor: V) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            Err(de::Error::custom("I'm just here for the fields"))
        }

        fn deserialize_enum<V>(
            self,
            _name: &'static str,
            variants: &'static [&'static str],
            _visitor: V,
        ) -> Result<V::Value, Self::Error>
        where
            V: Visitor<'de>,
        {
            *self.variants = Some(variants);
            Err(de::Error::custom("I'm just here for the fields"))
        }

        serde::forward_to_deserialize_any! {
            bool i8 i16 i32 i64 u8 u16 u32 u64 f32 f64 char str string bytes
            byte_buf option unit unit_struct newtype_struct seq tuple
            tuple_struct map struct identifier ignored_any
        }
    }

    let mut serialized_names = None;
    let _ = T::deserialize(EnumVariantsDeserializer {
        variants: &mut serialized_names,
    });
    let _ = T::deserialize(StructFieldsDeserializer {
        fields: &mut serialized_names,
    });
    serialized_names.unwrap_or_default()
}

#[cfg(test)]
mod tests {
    #![allow(dead_code)]

    use crate::prelude::serde_introspect;

    #[test]
    fn serde_introspect_given_struct_introspect_serialization_names() {
        #[derive(serde::Deserialize, Debug)]
        enum SomeEnum {
            #[serde(rename = "a")]
            EnumA,
            #[serde(rename = "b")]
            EnumB,
        }
        #[derive(serde::Deserialize, Debug)]
        struct AnotherStruct {
            #[serde(rename = "a3")]
            aaa: Option<i64>,
            #[serde(rename = "b3")]
            bbb: i128,
            #[serde(rename = "c3")]
            ccc: u128,
            #[serde(rename = "d3")]
            ddd: SomeEnum,
        }
        let names = serde_introspect::<AnotherStruct>();
        assert_eq!(names[0], "a3");
        assert_eq!(names[1], "b3");
        assert_eq!(names[2], "c3");
        assert_eq!(names[3], "d3");
    }

    #[test]
    fn serde_introspect_enum_struct_introspect_serialization_names() {
        #[derive(serde::Deserialize, Debug)]
        enum SomeEnum {
            #[serde(rename = "a")]
            EnumA,
            #[serde(rename = "b")]
            EnumB,
        }

        let names = serde_introspect::<SomeEnum>();
        assert_eq!(names[0], "a");
        assert_eq!(names[1], "b");
    }
}