logo
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
use crate::{Prefix, XorName};
use serde::{
    de::{self, Visitor},
    ser::SerializeStruct,
    Deserialize, Deserializer, Serialize, Serializer,
};
use std::{fmt, str::FromStr};

impl Serialize for XorName {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        // Return string with hexadecimal representation
        if serializer.is_human_readable() {
            return serializer.serialize_str(&hex::encode(self.0));
        }

        // Default serialization.
        serializer.serialize_newtype_struct("XorName", &self.0)
    }
}

impl<'de> Deserialize<'de> for XorName {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        if deserializer.is_human_readable() {
            struct XorNameHexStrVisitor;
            impl<'de> Visitor<'de> for XorNameHexStrVisitor {
                type Value = XorName;

                fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                    write!(formatter, "32 byte hex string")
                }

                fn visit_str<E>(self, s: &str) -> Result<Self::Value, E>
                where
                    E: de::Error,
                {
                    let buffer = <[u8; 32] as hex::FromHex>::from_hex(s)
                        .map_err(|e| E::custom(std::format!("hex decoding ({})", e)))?;
                    Ok(XorName(buffer))
                }
            }
            return deserializer.deserialize_str(XorNameHexStrVisitor);
        }

        #[derive(Deserialize)]
        #[serde(rename = "XorName")]
        struct XorNameDerived([u8; 32]);
        let x = <XorNameDerived as Deserialize>::deserialize(deserializer)?;
        Ok(XorName(x.0))
    }
}

impl Serialize for Prefix {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        if serializer.is_human_readable() {
            // Use `Display` impl from `Prefix`
            return serializer.serialize_str(&std::format!("{}", self));
        }

        let mut s = serializer.serialize_struct("Prefix", 2)?;
        s.serialize_field("bit_count", &self.bit_count)?;
        s.serialize_field("name", &self.name)?;
        s.end()
    }
}
impl<'de> Deserialize<'de> for Prefix {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        if deserializer.is_human_readable() {
            struct PrefixVisitor;
            impl<'de> Visitor<'de> for PrefixVisitor {
                type Value = Prefix;

                fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                    write!(formatter, "binary formatted string")
                }

                fn visit_str<E>(self, s: &str) -> Result<Self::Value, E>
                where
                    E: de::Error,
                {
                    Prefix::from_str(s).map_err(|e| {
                        E::custom(std::format!("could not convert string to `Prefix`: {e}"))
                    })
                }
            }
            return deserializer.deserialize_str(PrefixVisitor);
        }

        #[derive(Deserialize)]
        #[serde(rename = "Prefix")]
        struct PrefixDerived {
            bit_count: u16,
            name: XorName,
        }
        let p = <PrefixDerived as Deserialize>::deserialize(deserializer)?;
        Ok(Prefix {
            bit_count: p.bit_count,
            name: p.name,
        })
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use serde_test::*;

    /// `XorName` with derived `Serialize` impl. Used to compare against.
    #[derive(PartialEq, Debug, serde::Serialize, Deserialize)]
    struct XorNameDerived([u8; 32]);

    /// `Prefix` with derived `Serialize` impl. Used to compare against.
    #[derive(PartialEq, Debug, serde::Serialize, Deserialize)]
    struct PrefixDerived {
        bit_count: u16,
        name: XorNameDerived,
    }

    #[test]
    fn xorname_ser_de() {
        let xor = XorName([0xAA; 32]);
        let xor_derived = XorNameDerived([0xAA; 32]);

        let xor_hex_str = static_str("aa".repeat(32));
        assert_tokens(&xor.readable(), &[Token::Str(xor_hex_str)]);

        assert_tokens(&xor.compact(), &xor_tokens("XorName"));
        // Verify our `Serialize` impl is same as when it would be derived
        assert_tokens(&xor_derived.compact(), &xor_tokens("XorNameDerived"));
    }

    #[test]
    fn prefix_ser_de() {
        let bit_count = 15;
        let prefix = Prefix {
            bit_count,
            name: XorName([0xAA; 32]),
        };
        let prefix_derived = PrefixDerived {
            bit_count,
            name: XorNameDerived([0xAA; 32]),
        };

        assert_tokens(&prefix.readable(), &[Token::Str("101010101010101")]);

        assert_tokens(
            &prefix.compact(),
            &prefix_tokens(bit_count, "Prefix", "XorName"),
        );
        // Verify our `Serialize` impl is same as when it would be derived
        assert_tokens(
            &prefix_derived.compact(),
            &prefix_tokens(bit_count, "PrefixDerived", "XorNameDerived"),
        );
    }

    // Little helper to leak a &str to obtain a static str (`Token::Str` requires &'static str)
    fn static_str(s: String) -> &'static str {
        Box::leak(s.into_boxed_str())
    }

    // Compact/derived representation of `XorName`
    fn xor_tokens(name: &'static str) -> Vec<Token> {
        let mut a = vec![];
        a.extend_from_slice(&[Token::NewtypeStruct { name }, Token::Tuple { len: 32 }]);
        a.extend_from_slice(&[Token::U8(0xAA); 32]); // Repeat a U8 Token 32 times
        a.extend_from_slice(&[Token::TupleEnd]);
        a
    }

    // Compact/derived representation of `Prefix`
    fn prefix_tokens(bit_count: u16, name: &'static str, name2: &'static str) -> Vec<Token> {
        let mut v = vec![
            Token::Struct { name, len: 2 },
            Token::Str("bit_count"),
            Token::U16(bit_count),
            Token::Str("name"),
        ];
        v.extend_from_slice(&xor_tokens(name2));
        v.extend_from_slice(&[Token::StructEnd]);
        v
    }
}