Struct HashMapRef

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

A reference to a HashMap, constructed with HashMap::pin or HashMap::with_guard.

The current thread will be pinned for the duration of this reference. Keep in mind that this prevents the collection of garbage generated by the map.

Implementations

impl<K, V, S> HashMapRef<'_, K, V, S>

pub fn len(&self) -> usize

Returns the number of entries in the map.

See also HashMap::len.

pub fn is_empty(&self) -> bool

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

See also HashMap::is_empty.

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

An iterator visiting all key-value pairs in arbitrary order.

The iterator element type is (&'g K, &'g V).

See also HashMap::iter.

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

An iterator visiting all keys in arbitrary order.

The iterator element type is &'g K.

See also HashMap::keys.

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

An iterator visiting all values in arbitrary order.

The iterator element type is &'g V.

See also HashMap::values.

impl<K, V, S> HashMapRef<'_, K, V, S>

where K: Clone + Ord,

pub fn reserve(&self, additional: usize)

Tries to reserve capacity for at least additional more elements to be inserted in the HashMap.

The collection may reserve more space to avoid frequent reallocations.

See also HashMap::reserve.

impl<K, V, S> HashMapRef<'_, K, V, S>

where K: Hash + Ord, S: BuildHasher,

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

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

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

See also HashMap::contains_key.

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

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

Returns a reference to the value corresponding to the key.

See also HashMap::get.

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

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

Returns the key-value pair corresponding to key.

See also HashMap::get_key_value.

impl<K, V, S> HashMapRef<'_, K, V, S>

where K: Clone + Ord,

pub fn clear(&self)

Clears the map, removing all key-value pairs.

See also HashMap::clear.

impl<K, V, S> HashMapRef<'_, K, V, S>

where K: Sync + Send + Clone + Hash + Ord, V: Sync + Send, S: BuildHasher,

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

Inserts a key-value pair into the map.

See also HashMap::insert.

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

Inserts a key-value pair into the map unless the key already exists.

See also HashMap::try_insert.

pub fn compute_if_present<'g, Q, F>( &'g self, key: &Q, remapping_function: F, ) -> Option<&'g V>

where K: Borrow<Q>, Q: ?Sized + Hash + Ord, F: FnOnce(&K, &V) -> Option<V>,

If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.

See also HashMap::compute_if_present.

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

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

Removes a key-value pair from the map, and returns the removed value (if any).

See also HashMap::remove.

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

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

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

See also HashMap::remove_entry.

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

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

Retains only the elements specified by the predicate.

See also HashMap::retain.

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

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

Retains only the elements specified by the predicate.

See also HashMap::retain_force.

Trait Implementations

impl<K, V, S> Clone for HashMapRef<'_, K, V, S>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

where K: Debug, V: Debug,

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

Formats the value using the given formatter.

impl<K, Q, V, S> Index<&Q> for HashMapRef<'_, K, V, S>

where K: Hash + Ord + Borrow<Q>, Q: ?Sized + Hash + Ord, S: BuildHasher,

type Output = V

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

type IntoIter = Iter<'g, K, V>

Which kind of iterator are we turning this into?

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

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V, S> PartialEq<HashMap<K, V, S>> for HashMapRef<'_, K, V, S>

where K: Hash + Ord, V: PartialEq, S: BuildHasher,

fn eq(&self, other: &HashMap<K, V, S>) -> 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<K, V, S> PartialEq<HashMapRef<'_, K, V, S>> for HashMap<K, V, S>

where K: Hash + Ord, V: PartialEq, S: BuildHasher,

fn eq(&self, other: &HashMapRef<'_, K, V, S>) -> 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<K, V, S> PartialEq for HashMapRef<'_, K, V, S>

where K: Hash + Ord, V: PartialEq, S: BuildHasher,

fn eq(&self, other: &Self) -> 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<K, V, S> Eq for HashMapRef<'_, K, V, S>

where K: Hash + Ord, V: Eq, S: BuildHasher,