Struct flurry::HashMapRef

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

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.

Methods

impl<'_, K, V, S> HashMapRef<'_, K, V, S> where
    K: Sync + Send + Clone + Hash + Eq,
    V: Sync + Send,
    S: BuildHasher, 

pub fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool where
    K: Borrow<Q>,
    Q: Hash + Eq, 

Tests if key is a key in this table. See also HashMap::contains_key.

pub fn get<'g, Q: ?Sized>(&'g self, key: &Q) -> Option<&'g V> where
    K: Borrow<Q>,
    Q: Hash + Eq, 

Returns the value to which key is mapped. See also HashMap::get.

pub fn get_key_value<'g, Q: ?Sized>(&'g self, key: &Q) -> Option<(&'g K, &'g V)> where
    K: Borrow<Q>,
    Q: Hash + Eq, 

Returns the key-value pair corresponding to key. See also HashMap::get_key_value.

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

Maps key to value in this table. See also HashMap::insert.

pub fn clear(&self)

Removes all entries from this map. See also HashMap::clear.

pub fn compute_if_present<'g, Q: ?Sized, F>(
    &'g self,
    key: &Q,
    remapping_function: F
) -> Option<&'g V> where
    K: Borrow<Q>,
    Q: Hash + Eq,
    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 reserve(&self, additional: usize)

Tries to reserve capacity for at least additional more elements. See also HashMap::reserve.

pub fn remove<'g, Q: ?Sized>(&'g self, key: &Q) -> Option<&'g V> where
    K: Borrow<Q>,
    Q: Hash + Eq, 

Removes the key (and its corresponding value) from this map. See also HashMap::remove.

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.

Important traits for Iter<'g, K, V>

impl<'g, K, V> Iterator for Iter<'g, K, V> type Item = (&'g K, &'g V);

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.

Important traits for Keys<'g, K, V>

impl<'g, K, V> Iterator for Keys<'g, K, V> type Item = &'g K;

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.

Important traits for Values<'g, K, V>

impl<'g, K, V> Iterator for Values<'g, K, V> type Item = &'g V;

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.

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.

Trait Implementations

impl<'_, K, V, S> Clone for HashMapRef<'_, K, V, S> where
    K: Sync + Send + Clone + Hash + Eq,
    V: Sync + Send,
    S: BuildHasher, 

fn clone(&self) -> Self

Returns a copy 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: Sync + Send + Clone + Hash + Eq + Debug,
    V: Sync + Send + Debug,
    S: BuildHasher, 

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

Formats the value using the given formatter.

impl<'_, K, V, S> Eq for HashMapRef<'_, K, V, S> where
    K: Sync + Send + Clone + Hash + Eq,
    V: Sync + Send + Eq,
    S: BuildHasher, 

impl<'_, '_, K, Q: ?Sized, V, S> Index<&'_ Q> for HashMapRef<'_, K, V, S> where
    K: Sync + Send + Clone + Hash + Eq + Borrow<Q>,
    Q: Hash + Eq,
    V: Sync + Send,
    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> where
    K: Sync + Send + Clone + Hash + Eq,
    V: Sync + Send,
    S: BuildHasher, 

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: Sync + Send + Clone + Hash + Eq,
    V: Sync + Send + PartialEq,
    S: BuildHasher, 

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, K, V, S> PartialEq<HashMapRef<'_, K, V, S>> for HashMapRef<'_, K, V, S> where
    K: Sync + Send + Clone + Hash + Eq,
    V: Sync + Send + PartialEq,
    S: BuildHasher, 

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, K, V, S> PartialEq<HashMapRef<'_, K, V, S>> for HashMap<K, V, S> where
    K: Sync + Send + Clone + Hash + Eq,
    V: Sync + Send + PartialEq,
    S: BuildHasher, 

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.