Skip to content

Commit f552bdb

Browse files
borsbors
committed
Auto merge of #432 - Amanieu:rkyv, r=Amanieu
Add support for rkyv serialization and deserialization This is direct port of the implementation within the `rkyv` crate, which targets an older version of hashbrown.
2 parents 33afe8f + 3542d10 commit f552bdb

File tree

6 files changed

+258
-8
lines changed

6 files changed

+258
-8
lines changed

‎Cargo.toml

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ ahash = { version = "0.8.0", default-features = false, optional = true }
1919
# For external trait impls
2020
rayon = { version = "1.0", optional = true }
2121
serde = { version = "1.0.25", default-features = false, optional = true }
22+
rkyv = { version = "0.7.42", optional = true, default-features = false, features = ["alloc"]}
2223

2324
# When built as part of libstd
2425
core = { version = "1.0.0", optional = true, package = "rustc-std-workspace-core" }
@@ -36,20 +37,15 @@ fnv = "1.0.7"
3637
serde_test = "1.0"
3738
doc-comment = "0.3.1"
3839
bumpalo = "3.6.0"
40+
rkyv = { version = "0.7.42", features = ["validation"] }
3941

4042
[features]
4143
default = ["ahash", "inline-more", "allocator-api2"]
4244

4345
nightly = ["allocator-api2?/nightly", "bumpalo/allocator_api"]
4446

4547
rustc-internal-api = []
46-
rustc-dep-of-std = [
47-
"nightly",
48-
"core",
49-
"compiler_builtins",
50-
"alloc",
51-
"rustc-internal-api",
52-
]
48+
rustc-dep-of-std = ["nightly", "core", "compiler_builtins", "alloc", "rustc-internal-api"]
5349
raw = []
5450

5551
# Enables usage of `#[inline]` on far more functions than by default in this

‎src/external_trait_impls/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
#[cfg(feature = "rayon")]
22
pub(crate) mod rayon;
3+
#[cfg(feature = "rkyv")]
4+
mod rkyv;
35
#[cfg(feature = "serde")]
46
mod serde;

‎src/external_trait_impls/rkyv/hash_map.rs

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
use crate::HashMap;
2+
use core::{
3+
borrow::Borrow,
4+
hash::{BuildHasher, Hash},
5+
};
6+
use rkyv::{
7+
collections::hash_map::{ArchivedHashMap, HashMapResolver},
8+
ser::{ScratchSpace, Serializer},
9+
Archive, Deserialize, Fallible, Serialize,
10+
};
11+
12+
impl<K: Archive + Hash + Eq, V: Archive, S> Archive for HashMap<K, V, S>
13+
where
14+
K::Archived: Hash + Eq,
15+
{
16+
type Archived = ArchivedHashMap<K::Archived, V::Archived>;
17+
type Resolver = HashMapResolver;
18+
19+
#[inline]
20+
unsafe fn resolve(&self, pos: usize, resolver: Self::Resolver, out: *mut Self::Archived) {
21+
ArchivedHashMap::resolve_from_len(self.len(), pos, resolver, out);
22+
}
23+
}
24+
25+
impl<K, V, S, RandomState> Serialize<S> for HashMap<K, V, RandomState>
26+
where
27+
K: Serialize<S> + Hash + Eq,
28+
K::Archived: Hash + Eq,
29+
V: Serialize<S>,
30+
S: Serializer + ScratchSpace + ?Sized,
31+
{
32+
#[inline]
33+
fn serialize(&self, serializer: &mut S) -> Result<Self::Resolver, S::Error> {
34+
unsafe { ArchivedHashMap::serialize_from_iter(self.iter(), serializer) }
35+
}
36+
}
37+
38+
impl<K: Archive + Hash + Eq, V: Archive, D: Fallible + ?Sized, S: Default + BuildHasher>
39+
Deserialize<HashMap<K, V, S>, D> for ArchivedHashMap<K::Archived, V::Archived>
40+
where
41+
K::Archived: Deserialize<K, D> + Hash + Eq,
42+
V::Archived: Deserialize<V, D>,
43+
{
44+
#[inline]
45+
fn deserialize(&self, deserializer: &mut D) -> Result<HashMap<K, V, S>, D::Error> {
46+
let mut result = HashMap::with_capacity_and_hasher(self.len(), S::default());
47+
for (k, v) in self.iter() {
48+
result.insert(k.deserialize(deserializer)?, v.deserialize(deserializer)?);
49+
}
50+
Ok(result)
51+
}
52+
}
53+
54+
impl<K: Hash + Eq + Borrow<AK>, V, AK: Hash + Eq, AV: PartialEq<V>, S: BuildHasher>
55+
PartialEq<HashMap<K, V, S>> for ArchivedHashMap<AK, AV>
56+
{
57+
#[inline]
58+
fn eq(&self, other: &HashMap<K, V, S>) -> bool {
59+
if self.len() != other.len() {
60+
false
61+
} else {
62+
self.iter()
63+
.all(|(key, value)| other.get(key).map_or(false, |v| value.eq(v)))
64+
}
65+
}
66+
}
67+
68+
impl<K: Hash + Eq + Borrow<AK>, V, AK: Hash + Eq, AV: PartialEq<V>>
69+
PartialEq<ArchivedHashMap<AK, AV>> for HashMap<K, V>
70+
{
71+
#[inline]
72+
fn eq(&self, other: &ArchivedHashMap<AK, AV>) -> bool {
73+
other.eq(self)
74+
}
75+
}
76+
77+
#[cfg(test)]
78+
mod tests {
79+
use crate::HashMap;
80+
use alloc::string::String;
81+
use rkyv::{
82+
archived_root, check_archived_root,
83+
ser::{serializers::AllocSerializer, Serializer},
84+
Deserialize, Infallible,
85+
};
86+
87+
#[test]
88+
fn index_map() {
89+
let mut value = HashMap::new();
90+
value.insert(String::from("foo"), 10);
91+
value.insert(String::from("bar"), 20);
92+
value.insert(String::from("baz"), 40);
93+
value.insert(String::from("bat"), 80);
94+
95+
let mut serializer = AllocSerializer::<4096>::default();
96+
serializer.serialize_value(&value).unwrap();
97+
let result = serializer.into_serializer().into_inner();
98+
let archived = unsafe { archived_root::<HashMap<String, i32>>(result.as_ref()) };
99+
100+
assert_eq!(value.len(), archived.len());
101+
for (k, v) in value.iter() {
102+
let (ak, av) = archived.get_key_value(k.as_str()).unwrap();
103+
assert_eq!(k, ak);
104+
assert_eq!(v, av);
105+
}
106+
107+
let deserialized: HashMap<String, i32> = archived.deserialize(&mut Infallible).unwrap();
108+
assert_eq!(value, deserialized);
109+
}
110+
111+
#[test]
112+
fn validate_index_map() {
113+
let mut value = HashMap::new();
114+
value.insert(String::from("foo"), 10);
115+
value.insert(String::from("bar"), 20);
116+
value.insert(String::from("baz"), 40);
117+
value.insert(String::from("bat"), 80);
118+
119+
let mut serializer = AllocSerializer::<4096>::default();
120+
serializer.serialize_value(&value).unwrap();
121+
let result = serializer.into_serializer().into_inner();
122+
check_archived_root::<HashMap<String, i32>>(result.as_ref())
123+
.expect("failed to validate archived index map");
124+
}
125+
}

‎src/external_trait_impls/rkyv/hash_set.rs

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
use crate::HashSet;
2+
use core::{
3+
borrow::Borrow,
4+
hash::{BuildHasher, Hash},
5+
};
6+
use rkyv::{
7+
collections::hash_set::{ArchivedHashSet, HashSetResolver},
8+
ser::{ScratchSpace, Serializer},
9+
Archive, Deserialize, Fallible, Serialize,
10+
};
11+
12+
impl<K: Archive + Hash + Eq, S> Archive for HashSet<K, S>
13+
where
14+
K::Archived: Hash + Eq,
15+
{
16+
type Archived = ArchivedHashSet<K::Archived>;
17+
type Resolver = HashSetResolver;
18+
19+
#[inline]
20+
unsafe fn resolve(&self, pos: usize, resolver: Self::Resolver, out: *mut Self::Archived) {
21+
ArchivedHashSet::<K::Archived>::resolve_from_len(self.len(), pos, resolver, out);
22+
}
23+
}
24+
25+
impl<K, S, RS> Serialize<S> for HashSet<K, RS>
26+
where
27+
K::Archived: Hash + Eq,
28+
K: Serialize<S> + Hash + Eq,
29+
S: ScratchSpace + Serializer + ?Sized,
30+
{
31+
#[inline]
32+
fn serialize(&self, serializer: &mut S) -> Result<Self::Resolver, S::Error> {
33+
unsafe { ArchivedHashSet::serialize_from_iter(self.iter(), serializer) }
34+
}
35+
}
36+
37+
impl<K, D, S> Deserialize<HashSet<K, S>, D> for ArchivedHashSet<K::Archived>
38+
where
39+
K: Archive + Hash + Eq,
40+
K::Archived: Deserialize<K, D> + Hash + Eq,
41+
D: Fallible + ?Sized,
42+
S: Default + BuildHasher,
43+
{
44+
#[inline]
45+
fn deserialize(&self, deserializer: &mut D) -> Result<HashSet<K, S>, D::Error> {
46+
let mut result = HashSet::with_hasher(S::default());
47+
for k in self.iter() {
48+
result.insert(k.deserialize(deserializer)?);
49+
}
50+
Ok(result)
51+
}
52+
}
53+
54+
impl<K: Hash + Eq + Borrow<AK>, AK: Hash + Eq, S: BuildHasher> PartialEq<HashSet<K, S>>
55+
for ArchivedHashSet<AK>
56+
{
57+
#[inline]
58+
fn eq(&self, other: &HashSet<K, S>) -> bool {
59+
if self.len() != other.len() {
60+
false
61+
} else {
62+
self.iter().all(|key| other.get(key).is_some())
63+
}
64+
}
65+
}
66+
67+
impl<K: Hash + Eq + Borrow<AK>, AK: Hash + Eq, S: BuildHasher> PartialEq<ArchivedHashSet<AK>>
68+
for HashSet<K, S>
69+
{
70+
#[inline]
71+
fn eq(&self, other: &ArchivedHashSet<AK>) -> bool {
72+
other.eq(self)
73+
}
74+
}
75+
76+
#[cfg(test)]
77+
mod tests {
78+
use crate::HashSet;
79+
use alloc::string::String;
80+
use rkyv::{
81+
archived_root, check_archived_root,
82+
ser::{serializers::AllocSerializer, Serializer},
83+
Deserialize, Infallible,
84+
};
85+
86+
#[test]
87+
fn index_set() {
88+
let mut value = HashSet::new();
89+
value.insert(String::from("foo"));
90+
value.insert(String::from("bar"));
91+
value.insert(String::from("baz"));
92+
value.insert(String::from("bat"));
93+
94+
let mut serializer = AllocSerializer::<4096>::default();
95+
serializer.serialize_value(&value).unwrap();
96+
let result = serializer.into_serializer().into_inner();
97+
let archived = unsafe { archived_root::<HashSet<String>>(result.as_ref()) };
98+
99+
assert_eq!(value.len(), archived.len());
100+
for k in value.iter() {
101+
let ak = archived.get(k.as_str()).unwrap();
102+
assert_eq!(k, ak);
103+
}
104+
105+
let deserialized: HashSet<String> = archived.deserialize(&mut Infallible).unwrap();
106+
assert_eq!(value, deserialized);
107+
}
108+
109+
#[test]
110+
fn validate_index_set() {
111+
let mut value = HashSet::new();
112+
value.insert(String::from("foo"));
113+
value.insert(String::from("bar"));
114+
value.insert(String::from("baz"));
115+
value.insert(String::from("bat"));
116+
117+
let mut serializer = AllocSerializer::<4096>::default();
118+
serializer.serialize_value(&value).unwrap();
119+
let result = serializer.into_serializer().into_inner();
120+
check_archived_root::<HashSet<String>>(result.as_ref())
121+
.expect("failed to validate archived index set");
122+
}
123+
}

‎src/external_trait_impls/rkyv/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
mod hash_map;
2+
mod hash_set;

‎tests/rayon.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,9 @@ fn set_seq_par_equivalence_into_iter_empty() {
356356
let vec_seq = SET_EMPTY.clone().into_iter().collect::<Vec<_>>();
357357
let vec_par = SET_EMPTY.clone().into_par_iter().collect::<Vec<_>>();
358358

359-
assert_eq3!(vec_seq, vec_par, []);
359+
// Work around type inference failure introduced by rend dev-dependency.
360+
let empty: [char; 0] = [];
361+
assert_eq3!(vec_seq, vec_par, empty);
360362
}
361363

362364
#[test]

0 commit comments

Comments
 (0)