Struct HashMapRef

pub struct HashMapRef<'map, K, V, S, G> { /* private fields */ }

A pinned reference to a HashMap.

This type is created with HashMap::pin and can be used to easily access a HashMap without explicitly managing a guard. See the crate-level documentation for details.

Implementations

impl<'map, K, V, S, G> HashMapRef<'map, K, V, S, G>

where K: Hash + Eq, S: BuildHasher, G: Guard,

pub fn map(&self) -> &'map HashMap<K, V, S>

Returns a reference to the inner HashMap.

pub fn len(&self) -> usize

Returns the number of entries in the map.

See HashMap::len for details.

pub fn is_empty(&self) -> bool

Returns true if the map is empty. Otherwise returns false.

See HashMap::is_empty for details.

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

where Q: Equivalent<K> + Hash + ?Sized,

Returns true if the map contains a value for the specified key.

See HashMap::contains_key for details.

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

where Q: Equivalent<K> + Hash + ?Sized,

Returns a reference to the value corresponding to the key.

See HashMap::get for details.

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

where Q: Equivalent<K> + Hash + ?Sized,

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

See HashMap::get_key_value for details.

pub fn insert(&self, key: K, value: V) -> Option<&V>

Inserts a key-value pair into the map.

See HashMap::insert for details.

pub fn try_insert(&self, key: K, value: V) -> Result<&V, OccupiedError<'_, V>>

Tries to insert a key-value pair into the map, and returns a reference to the value that was inserted.

See HashMap::try_insert for details.

pub fn try_insert_with<F>(&self, key: K, f: F) -> Result<&V, &V>

where F: FnOnce() -> V,

Tries to insert a key and value computed from a closure into the map, and returns a reference to the value that was inserted.

See HashMap::try_insert_with for details.

pub fn get_or_insert(&self, key: K, value: V) -> &V

Returns a reference to the value corresponding to the key, or inserts a default value.

See HashMap::get_or_insert for details.

pub fn get_or_insert_with<F>(&self, key: K, f: F) -> &V

where F: FnOnce() -> V,

Returns a reference to the value corresponding to the key, or inserts a default value computed from a closure.

See HashMap::get_or_insert_with for details.

pub fn update<F>(&self, key: K, update: F) -> Option<&V>

where F: Fn(&V) -> V,

Updates an existing entry atomically.

See HashMap::update for details.

pub fn update_or_insert<F>(&self, key: K, update: F, value: V) -> &V

where F: Fn(&V) -> V,

Updates an existing entry or inserts a default value.

See HashMap::update_or_insert for details.

pub fn update_or_insert_with<U, F>(&self, key: K, update: U, f: F) -> &V

where F: FnOnce() -> V, U: Fn(&V) -> V,

Updates an existing entry or inserts a default value computed from a closure.

See HashMap::update_or_insert_with for details.

pub fn compute<'g, F, T>(&'g self, key: K, compute: F) -> Compute<'g, K, V, T>

where F: FnMut(Option<(&'g K, &'g V)>) -> Operation<V, T>,

See HashMap::compute for details.

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

where Q: Equivalent<K> + Hash + ?Sized,

Removes a key from the map, returning the value at the key if the key was previously in the map.

See HashMap::remove for details.

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

where Q: Equivalent<K> + Hash + ?Sized,

Removes a key from the map, returning the stored key and value if the key was previously in the map.

See HashMap::remove_entry for details.

pub fn remove_if<Q, F>( &self, key: &Q, should_remove: F, ) -> Result<Option<(&K, &V)>, (&K, &V)>

where Q: Equivalent<K> + Hash + ?Sized, F: FnMut(&K, &V) -> bool,

Conditionally removes a key from the map based on the provided closure.

See HashMap::remove_if for details.

pub fn clear(&self)

Clears the map, removing all key-value pairs.

See HashMap::clear for details.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&K, &V) -> bool,

Retains only the elements specified by the predicate.

See HashMap::retain for details.

pub fn reserve(&self, additional: usize)

Tries to reserve capacity for additional more elements to be inserted in the map.

See HashMap::reserve for details.

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

An iterator visiting all key-value pairs in arbitrary order. The iterator element type is (&K, &V).

See HashMap::iter for details.

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

An iterator visiting all keys in arbitrary order. The iterator element type is &K.

See HashMap::keys for details.

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

An iterator visiting all values in arbitrary order. The iterator element type is &V.

See HashMap::values for details.

Trait Implementations

impl<K, V, S, G> Debug for HashMapRef<'_, K, V, S, G>

where K: Hash + Eq + Debug, V: Debug, S: BuildHasher, G: Guard,

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

Formats the value using the given formatter.

impl<'a, K, V, S, G> IntoIterator for &'a HashMapRef<'_, K, V, S, G>

where K: Hash + Eq, S: BuildHasher, G: Guard,

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

type IntoIter = Iter<'a, K, V, G>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.