ringmap/
borsh.rs

1#![cfg_attr(docsrs, doc(cfg(feature = "borsh")))]
2
3use alloc::vec::Vec;
4use core::hash::BuildHasher;
5use core::hash::Hash;
6
7use borsh::error::ERROR_ZST_FORBIDDEN;
8use borsh::io::{Error, ErrorKind, Read, Result, Write};
9use borsh::{BorshDeserialize, BorshSerialize};
10
11use crate::map::RingMap;
12use crate::set::RingSet;
13
14impl<K, V, S> BorshSerialize for RingMap<K, V, S>
15where
16    K: BorshSerialize,
17    V: BorshSerialize,
18{
19    #[inline]
20    fn serialize<W: Write>(&self, writer: &mut W) -> Result<()> {
21        check_zst::<K>()?;
22
23        let iterator = self.iter();
24
25        u32::try_from(iterator.len())
26            .map_err(|_| ErrorKind::InvalidData)?
27            .serialize(writer)?;
28
29        for (key, value) in iterator {
30            key.serialize(writer)?;
31            value.serialize(writer)?;
32        }
33
34        Ok(())
35    }
36}
37
38impl<K, V, S> BorshDeserialize for RingMap<K, V, S>
39where
40    K: BorshDeserialize + Eq + Hash,
41    V: BorshDeserialize,
42    S: BuildHasher + Default,
43{
44    #[inline]
45    fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self> {
46        check_zst::<K>()?;
47        let vec = <Vec<(K, V)>>::deserialize_reader(reader)?;
48        Ok(vec.into_iter().collect::<RingMap<K, V, S>>())
49    }
50}
51
52impl<T, S> BorshSerialize for RingSet<T, S>
53where
54    T: BorshSerialize,
55{
56    #[inline]
57    fn serialize<W: Write>(&self, writer: &mut W) -> Result<()> {
58        check_zst::<T>()?;
59
60        let iterator = self.iter();
61
62        u32::try_from(iterator.len())
63            .map_err(|_| ErrorKind::InvalidData)?
64            .serialize(writer)?;
65
66        for item in iterator {
67            item.serialize(writer)?;
68        }
69
70        Ok(())
71    }
72}
73
74impl<T, S> BorshDeserialize for RingSet<T, S>
75where
76    T: BorshDeserialize + Eq + Hash,
77    S: BuildHasher + Default,
78{
79    #[inline]
80    fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self> {
81        check_zst::<T>()?;
82        let vec = <Vec<T>>::deserialize_reader(reader)?;
83        Ok(vec.into_iter().collect::<RingSet<T, S>>())
84    }
85}
86
87fn check_zst<T>() -> Result<()> {
88    if size_of::<T>() == 0 {
89        return Err(Error::new(ErrorKind::InvalidData, ERROR_ZST_FORBIDDEN));
90    }
91    Ok(())
92}
93
94#[cfg(test)]
95mod borsh_tests {
96    use super::*;
97
98    #[test]
99    fn map_borsh_roundtrip() {
100        let original_map: RingMap<i32, i32> = {
101            let mut map = RingMap::new();
102            map.insert(1, 2);
103            map.insert(3, 4);
104            map.insert(5, 6);
105            map
106        };
107        let serialized_map = borsh::to_vec(&original_map).unwrap();
108        let deserialized_map: RingMap<i32, i32> =
109            BorshDeserialize::try_from_slice(&serialized_map).unwrap();
110        assert_eq!(original_map, deserialized_map);
111    }
112
113    #[test]
114    fn set_borsh_roundtrip() {
115        let original_map: RingSet<i32> = [1, 2, 3, 4, 5, 6].into_iter().collect();
116        let serialized_map = borsh::to_vec(&original_map).unwrap();
117        let deserialized_map: RingSet<i32> =
118            BorshDeserialize::try_from_slice(&serialized_map).unwrap();
119        assert_eq!(original_map, deserialized_map);
120    }
121}