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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
#![allow(clippy::type_complexity)]
use core::hash::Hash;
use crate::buf::{StoreBuf, Visit};
use crate::error::Error;
use crate::phf::hashing::HashKey;
use crate::phf::{Entry, MapRef, SetRef};
use crate::Ref;
use crate::ZeroCopy;
/// Store a map based on a perfect hash function into a buffer.
///
/// This will utilize a perfect hash functions derived from the [`phf` crate] to
/// construct a persistent hash set.
///
/// This returns a [`MapRef`] which can be bound into a [`Map`] through the
/// [`bind()`] method for convenience.
///
/// [`phf` crate]: https://crates.io/crates/phf
/// [`Map`]: crate::phf::Map
/// [`bind()`]: crate::buf::Buf::bind
///
/// # Examples
///
/// ```
/// use musli_zerocopy::OwnedBuf;
/// use musli_zerocopy::phf;
///
/// let mut buf = OwnedBuf::new();
///
/// let first = buf.store_unsized("first");
/// let second = buf.store_unsized("second");
///
/// let map = phf::store_map(&mut buf, [(first, 1u32), (second, 2u32)])?;
/// let map = buf.bind(map)?;
///
/// assert_eq!(map.get("first")?, Some(&1));
/// assert_eq!(map.get(&first)?, Some(&1));
/// assert_eq!(map.get("second")?, Some(&2));
/// assert_eq!(map.get(&second)?, Some(&2));
/// assert_eq!(map.get("third")?, None);
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
///
/// Using non-references as keys:
///
/// ```
/// use musli_zerocopy::OwnedBuf;
/// use musli_zerocopy::phf;
///
/// let mut buf = OwnedBuf::new();
///
/// let map = phf::store_map(&mut buf, [(10u64, 1), (20u64, 2)])?;
/// let map = buf.bind(map)?;
///
/// assert_eq!(map.get(&10u64)?, Some(&1));
/// assert_eq!(map.get(&20u64)?, Some(&2));
/// assert_eq!(map.get(&30u64)?, None);
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
pub fn store_map<K, V, S, I>(
buf: &mut S,
entries: I,
) -> Result<MapRef<K, V, S::ByteOrder, S::Size>, Error>
where
K: Visit + ZeroCopy,
V: ZeroCopy,
K::Target: Hash,
S: ?Sized + StoreBuf,
I: IntoIterator<Item = (K, V)>,
I::IntoIter: ExactSizeIterator,
{
let entries = entries.into_iter().map(|(k, v)| Entry::new(k, v));
let (key, entries, displacements) = store_raw(buf, entries, |entry| &entry.key)?;
Ok(MapRef::new(key, entries, displacements))
}
/// Store a set based on a perfect hash function into a buffer.
///
/// This will utilize a perfect hash functions derived from the [`phf` crate] to
/// construct a persistent hash map.
///
/// This returns a [`SetRef`] which can be bound into a [`Set`] through the
/// [`bind()`] method for convenience.
///
/// [`phf` crate]: https://crates.io/crates/phf
/// [`Set`]: crate::phf::Set
/// [`bind()`]: crate::buf::Buf::bind
///
/// # Examples
///
/// ```
/// use musli_zerocopy::OwnedBuf;
/// use musli_zerocopy::phf;
///
/// let mut buf = OwnedBuf::new();
///
/// let first = buf.store_unsized("first");
/// let second = buf.store_unsized("second");
/// let third = buf.store_unsized("third");
///
/// let set = phf::store_set(&mut buf, [first, second])?;
/// let set = buf.bind(set)?;
///
/// assert!(set.contains("first")?);
/// assert!(set.contains(&first)?);
/// assert!(set.contains("second")?);
/// assert!(set.contains(&second)?);
/// assert!(!set.contains("third")?);
/// assert!(!set.contains(&third)?);
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
///
/// Using non-references as keys:
///
/// ```
/// use musli_zerocopy::OwnedBuf;
/// use musli_zerocopy::phf;
///
/// let mut buf = OwnedBuf::new();
///
/// let set = phf::store_set(&mut buf, [1, 2])?;
/// let set = buf.bind(set)?;
///
/// assert!(set.contains(&1)?);
/// assert!(set.contains(&2)?);
/// assert!(!set.contains(&3)?);
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
pub fn store_set<S, I>(
buf: &mut S,
entries: I,
) -> Result<SetRef<I::Item, S::ByteOrder, S::Size>, Error>
where
S: ?Sized + StoreBuf,
I: IntoIterator,
I::Item: Visit + ZeroCopy,
<I::Item as Visit>::Target: Hash,
I::IntoIter: ExactSizeIterator,
{
let (key, entries, displacements) = store_raw(buf, entries, |entry| entry)?;
Ok(SetRef::new(key, entries, displacements))
}
fn store_raw<K, I, S, F>(
buf: &mut S,
entries: I,
access: F,
) -> Result<
(
HashKey,
Ref<[I::Item], S::ByteOrder, S::Size>,
Ref<[Entry<u32, u32>], S::ByteOrder, S::Size>,
),
Error,
>
where
K: Visit + ZeroCopy,
K::Target: Hash,
I: IntoIterator,
I::Item: ZeroCopy,
I::IntoIter: ExactSizeIterator,
S: ?Sized + StoreBuf,
F: Fn(&I::Item) -> &K,
{
let entries = build_slice(buf, entries);
let len = crate::phf::generator::displacements_len(entries.len());
let displacements = build_slice(buf, (0..len).map(|_| Entry::new(0, 0)));
let len = buf.len();
let map = build_slice(buf, (0..entries.len()).map(|_| usize::MAX));
let hash_state = {
buf.align_in_place();
crate::phf::generator::generate_hash(
buf.as_mut_buf(),
&entries,
&displacements,
&map,
access,
)?
};
for (from, a) in map.iter().enumerate() {
loop {
let to = *buf.as_mut_buf().load(a)?;
if from != to {
buf.swap(entries.at(from), entries.at(to))?;
buf.swap(map.at(from), map.at(to))?;
continue;
}
break;
}
}
// Free up temporary memory we needed to build the map.
buf.truncate(len);
Ok((hash_state.key, entries, displacements))
}
fn build_slice<S, I>(buf: &mut S, entries: I) -> Ref<[I::Item], S::ByteOrder, S::Size>
where
S: ?Sized + StoreBuf,
I: IntoIterator,
I::Item: ZeroCopy,
I::IntoIter: ExactSizeIterator,
{
let offset = buf.next_offset::<I::Item>();
let iter = entries.into_iter();
let len = iter.len();
for value in iter {
buf.store(&value);
}
Ref::with_metadata(offset, len)
}