Struct rkyv::collections::hash_map::ArchivedHashMap

pub struct ArchivedHashMap<K, V> { /* private fields */ }

An archived HashMap.

Implementations

impl<K, V> ArchivedHashMap<K, V>

pub const fn len(&self) -> usize

Gets the number of items in the hash map.

pub fn hasher(&self) -> SeaHasher

Gets the hasher for this hashmap. The hasher for all archived hashmaps is the same for reproducibility.

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

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

Finds the key-value entry for a key.

pub fn get_key_value_pin<Q>( self: Pin<&mut Self>, k: &Q, ) -> Option<(&K, Pin<&mut V>)>

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

Finds the mutable key-value entry for a key.

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

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

Returns whether a key is present in the hash map.

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

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

Gets the value associated with the given key.

pub fn get_with<Q: Hash + ?Sized, F: Fn(&K, &Q) -> bool>( &self, key: &Q, comparison_predicate: F, ) -> Option<&V>

Gets the value associated with the given key, and matching the given predicate F.

This method uses the hash of the given key and the provided comparison function to find a matching element in the hash map. This is intended to be used when you are unable to construct a key that fulfils the criteria of get.

Note that hashes are not always guaranteed to match between Archived and non-archived versions of the same struct. This is also the case for Archived types that are automatically generated by #[derive(Archive)]. You should ensure that the hashing method matches between your types, otherwise this method might not return any value even though a value matching comparison_predicate exists.

Examples

let your_hashmap: ArchivedHashMap<(ArchivedString, ArchivedString), ArchivedString> = get_your_hashmap();
let your_value = your_hashmap.get_with(
     &("my", "key"),
     |hashmap_key, your_key| &(hashmap_key.0.as_str(), hashmap_key.1.as_str()) == your_key
    );

pub fn get_pin<Q>(self: Pin<&mut Self>, k: &Q) -> Option<Pin<&mut V>>

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

Gets the mutable value associated with the given key.

pub const fn is_empty(&self) -> bool

Returns true if the map contains no elements.

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

Gets an iterator over the key-value entries in the hash map.

pub fn iter_pin(self: Pin<&mut Self>) -> IterPin<'_, K, V>

Gets an iterator over the mutable key-value entries in the hash map.

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

Gets an iterator over the keys in the hash map.

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

Gets an iterator over the values in the hash map.

pub fn values_pin(self: Pin<&mut Self>) -> ValuesPin<'_, K, V>

Gets an iterator over the mutable values in the hash map.

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

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

Safety

• len must be the number of elements that were serialized
• pos must be the position of out within the archive
• resolver must be the result of serializing a hash map

impl<K, V> ArchivedHashMap<K, V>

pub unsafe fn serialize_from_iter<'a, KU, VU, S, I>( iter: I, serializer: &mut S, ) -> Result<HashMapResolver, S::Error>

where KU: 'a + Serialize<S, Archived = K> + Hash + Eq, VU: 'a + Serialize<S, Archived = V>, S: Serializer + ScratchSpace + ?Sized, I: ExactSizeIterator<Item = (&'a KU, &'a VU)>,

Serializes an iterator of key-value pairs as a hash map.

Safety

The keys returned by the iterator must be unique.

Trait Implementations

impl<K: Debug, V: Debug> Debug for ArchivedHashMap<K, V>

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

Formats the value using the given formatter.

impl<K: Archive + Hash + Eq, V: Archive, D: Fallible + ?Sized, S: Default + BuildHasher> Deserialize<HashMap<K, V, S>, D> for ArchivedHashMap<K::Archived, V::Archived>

where K::Archived: Deserialize<K, D> + Hash + Eq, V::Archived: Deserialize<V, D>,

fn deserialize( &self, deserializer: &mut D, ) -> Result<HashMap<K, V, S>, D::Error>

Deserializes using the given deserializer

impl<K: Archive + Hash + Eq, V: Archive, D: Fallible + ?Sized, S: Default + BuildHasher> Deserialize<HashMap<K, V, S>, D> for ArchivedHashMap<K::Archived, V::Archived>

where K::Archived: Deserialize<K, D> + Hash + Eq, V::Archived: Deserialize<V, D>,

fn deserialize( &self, deserializer: &mut D, ) -> Result<HashMap<K, V, S>, D::Error>

Deserializes using the given deserializer

impl<K: Eq + Hash + Borrow<Q>, Q: Eq + Hash + ?Sized, V> Index<&Q> for ArchivedHashMap<K, V>

type Output = V

The returned type after indexing.

fn index(&self, key: &Q) -> &V

Performs the indexing (container[index]) operation.

impl<K: Hash + Eq + Borrow<AK>, V, AK: Hash + Eq, AV: PartialEq<V>> PartialEq<ArchivedHashMap<AK, AV>> for HashMap<K, V>

fn eq(&self, other: &ArchivedHashMap<AK, AV>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<K: Hash + Eq + Borrow<AK>, V, AK: Hash + Eq, AV: PartialEq<V>> PartialEq<ArchivedHashMap<AK, AV>> for HashMap<K, V>

fn eq(&self, other: &ArchivedHashMap<AK, AV>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<K: Hash + Eq + Borrow<AK>, V, AK: Hash + Eq, AV: PartialEq<V>, S: BuildHasher> PartialEq<HashMap<K, V, S>> for ArchivedHashMap<AK, AV>

fn eq(&self, other: &HashMap<K, V, S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<K: Hash + Eq + Borrow<AK>, V, AK: Hash + Eq, AV: PartialEq<V>, S: BuildHasher> PartialEq<HashMap<K, V, S>> for ArchivedHashMap<AK, AV>

fn eq(&self, other: &HashMap<K, V, S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<K: Hash + Eq, V: PartialEq> PartialEq for ArchivedHashMap<K, V>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<K: Hash + Eq, V: Eq> Eq for ArchivedHashMap<K, V>