Struct ArchivedIndexMap

#[repr(C)]
pub struct ArchivedIndexMap<K, V, H = FxHasher64> { /* private fields */ }

Available on crate feature dep_rkyv only.

An archived IndexMap.

Implementations

impl<K, V, H> ArchivedIndexMap<K, V, H>

pub const fn is_empty(&self) -> bool

Returns true if the map contains no elements.

pub fn iter(&self) -> Iter<'_, K, V>

Returns an iterator over the key-value pairs of the map in order

pub fn keys(&self) -> Keys<'_, K, V>

Returns an iterator over the keys of the map in order

pub const fn len(&self) -> usize

Gets the number of items in the index map.

pub fn values(&self) -> Values<'_, K, V>

Returns an iterator over the values of the map in order.

impl<K, V, H> ArchivedIndexMap<K, V, H>

where H: Hasher + Default,

pub fn get_full_with<Q, C>(&self, key: &Q, cmp: C) -> Option<(usize, &K, &V)>

where Q: Hash + Eq + ?Sized, C: Fn(&Q, &K) -> bool,

Gets the index, key, and value corresponding to the supplied key using the given comparison function.

pub fn get_full<Q>(&self, key: &Q) -> Option<(usize, &K, &V)>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Gets the index, key, and value corresponding to the supplied key.

pub fn get_key_value_with<Q, C>(&self, key: &Q, cmp: C) -> Option<(&K, &V)>

where Q: Hash + Eq + ?Sized, C: Fn(&Q, &K) -> bool,

Returns the key-value pair corresponding to the supplied key using the given comparison function.

pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns the key-value pair corresponding to the supplied key.

pub fn get_with<Q, C>(&self, key: &Q, cmp: C) -> Option<&V>

where Q: Hash + Eq + ?Sized, C: Fn(&Q, &K) -> bool,

Returns a reference to the value corresponding to the supplied key using the given comparison function.

pub fn get<Q>(&self, key: &Q) -> Option<&V>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns a reference to the value corresponding to the supplied key.

pub fn get_full_seal_with<'a, Q, C>( this: Seal<'a, ArchivedIndexMap<K, V, H>>, key: &Q, cmp: C, ) -> Option<(usize, &'a K, Seal<'a, V>)>

where Q: Hash + Eq + ?Sized, C: Fn(&Q, &K) -> bool,

Gets the mutable index, key, and value corresponding to the supplied key using the given comparison function.

pub fn get_full_seal<'a, Q>( this: Seal<'a, ArchivedIndexMap<K, V, H>>, key: &Q, ) -> Option<(usize, &'a K, Seal<'a, V>)>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Gets the mutable index, key, and value corresponding to the supplied key.

pub fn get_key_value_seal_with<'a, Q, C>( this: Seal<'a, ArchivedIndexMap<K, V, H>>, key: &Q, cmp: C, ) -> Option<(&'a K, Seal<'a, V>)>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized, C: Fn(&Q, &K) -> bool,

Returns the mutable key-value pair corresponding to the supplied key using the given comparison function.

pub fn get_key_value_seal<'a, Q>( this: Seal<'a, ArchivedIndexMap<K, V, H>>, key: &Q, ) -> Option<(&'a K, Seal<'a, V>)>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns the mutable key-value pair corresponding to the supplied key.

pub fn get_seal_with<'a, Q, C>( this: Seal<'a, ArchivedIndexMap<K, V, H>>, key: &Q, cmp: C, ) -> Option<Seal<'a, V>>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized, C: Fn(&Q, &K) -> bool,

Returns a mutable reference to the value corresponding to the supplied key using the given comparison function.

pub fn get_seal<'a, Q>( this: Seal<'a, ArchivedIndexMap<K, V, H>>, key: &Q, ) -> Option<Seal<'a, V>>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns a mutable reference to the value corresponding to the supplied key.

pub fn contains_key<Q>(&self, key: &Q) -> bool

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns whether a key is present in the hash map.

pub fn get_index(&self, index: usize) -> Option<(&K, &V)>

Gets a key-value pair by index.

pub fn get_index_of_with<Q, C>(&self, key: &Q, cmp: C) -> Option<usize>

where Q: Hash + Eq + ?Sized, C: Fn(&Q, &K) -> bool,

Gets the index of a key if it exists in the map using the given comparison function.

pub fn get_index_of<Q>(&self, key: &Q) -> Option<usize>

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Gets the index of a key if it exists in the map.

pub fn resolve_from_len( len: usize, load_factor: (usize, usize), resolver: IndexMapResolver, out: Place<ArchivedIndexMap<K, V, H>>, )

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

pub fn serialize_from_iter<I, BKU, BVU, KU, VU, S>( iter: I, load_factor: (usize, usize), serializer: &mut S, ) -> Result<IndexMapResolver, <S as Fallible>::Error>

where I: Clone + ExactSizeIterator<Item = (BKU, BVU)>, BKU: Borrow<KU>, BVU: Borrow<VU>, KU: Serialize<S, Archived = K> + Hash + Eq, VU: Serialize<S, Archived = V>, S: Fallible + Writer + Allocator + ?Sized, <S as Fallible>::Error: Source,

Serializes an iterator of key-value pairs as an index map.

Trait Implementations

impl<K, V, H, __C> CheckBytes<__C> for ArchivedIndexMap<K, V, H>

where __C: Fallible + ?Sized, <__C as Fallible>::Error: Trace, ArchivedIndexMap<K, V, H>: Verify<__C>, ArchivedHashTable<u32_le>: CheckBytes<__C>, RelPtr<Entry<K, V>, i32_le>: CheckBytes<__C>, PhantomData<H>: CheckBytes<__C>,

unsafe fn check_bytes( value: *const ArchivedIndexMap<K, V, H>, context: &mut __C, ) -> Result<(), <__C as Fallible>::Error>

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

impl<K, V, H> Debug for ArchivedIndexMap<K, V, H>

where K: Debug, V: Debug,

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

Formats the value using the given formatter.

impl<K, V, H> PartialEq for ArchivedIndexMap<K, V, H>

where K: PartialEq, V: PartialEq,

fn eq(&self, other: &ArchivedIndexMap<K, V, H>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C, K, V, H> Verify<C> for ArchivedIndexMap<K, V, H>

where C: Fallible + ArchiveContext + ?Sized, <C as Fallible>::Error: Source, K: CheckBytes<C>, V: CheckBytes<C>,

fn verify(&self, context: &mut C) -> Result<(), <C as Fallible>::Error>

Checks whether the invariants of this type are upheld by self.

impl<K, V, H> Eq for ArchivedIndexMap<K, V, H>

where K: Eq, V: Eq,

impl<K, V, H> Portable for ArchivedIndexMap<K, V, H>

where ArchivedHashTable<u32_le>: Portable, RelPtr<Entry<K, V>, i32_le>: Portable, PhantomData<H>: Portable,