Struct rkyv::collections::hash_index::ArchivedHashIndex

pub struct ArchivedHashIndex { /* private fields */ }

An archived hash index.

Implementations

impl ArchivedHashIndex

pub const fn len(&self) -> usize

Gets the number of items in the hash index.

pub fn hasher(&self) -> HashBuilder

Gets the hasher for this hash index. The hasher for all archived hash indexes is the same for reproducibility.

pub fn index<K: Hash + ?Sized>(&self, k: &K) -> Option<usize>

Returns the index where a key may be located in the hash index.

The hash index does not have access to the keys used to build it, so the key at the returned index must be checked for equality.

pub const fn is_empty(&self) -> bool

Returns whether there are no items in the hash index.

pub unsafe fn resolve_from_len( len: usize, pos: usize, resolver: HashIndexResolver, out: *mut Self )

Resolves an archived hash index from a given length and parameters.

Safety

• len must be the number of elements in the hash index
• pos must be the position of out within the archive
• resolver must be the result of building and serializing a hash index

impl ArchivedHashIndex

pub unsafe fn build_and_serialize<'a, K, V, S, I>( iter: I, serializer: &mut S, entries: &mut ScratchVec<MaybeUninit<(&'a K, &'a V)>> ) -> Result<HashIndexResolver, S::Error>where K: 'a + Hash, V: 'a, S: Serializer + ScratchSpace + ?Sized, I: ExactSizeIterator<Item = (&'a K, &'a V)>,

Builds and serializes a hash index from an iterator of key-value pairs.

Safety

• The keys returned by the iterator must be unique.
• entries must have a capacity of iter.len() entries.

Trait Implementations

impl<C: ArchiveContext + ?Sized> CheckBytes<C> for ArchivedHashIndexwhere C::Error: Error,

type Error = HashIndexError<<C as Fallible>::Error>

The error that may result from checking the type.

unsafe fn check_bytes<'a>( value: *const Self, context: &mut C ) -> Result<&'a Self, Self::Error>

Checks whether the given pointer points to a valid value within the given context.

impl Debug for ArchivedHashIndex

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.