Struct ref_kind::RefKindMap

#[repr(transparent)]
pub struct RefKindMap<'a, K, V, S = RandomState> where
    V: ?Sized + 'a, { /* private fields */ }

Hash map for different kinds of reference.

This type provides methods for retrieving references (either immutable or mutable) by moving them out of the map to preserve specified lifetime of the owner.

Implementations

impl<'a, K, V, S> RefKindMap<'a, K, V, S> where
    K: Eq + Hash,
    V: ?Sized + 'a,
    S: BuildHasher, 

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

Returns an immutable reference of the value without preserving lifetime of the owner.

Panics

Panics if mutable reference of the value was already moved out of the map.

pub fn get_mut(&mut self, key: &K) -> Option<&mut V>

Returns a mutable reference of the value without preserving lifetime of the owner.

Panics

Panics if mutable reference of the value was already moved out of the map or the value was already borrowed as immutable.

pub fn move_ref(&mut self, key: K) -> Option<&'a V>

Moves an immutable reference of the value out of this map.

This function copies an immutable reference or replaces mutable reference with immutable one, preserving an immutable reference in this map.

Panics

Panics if mutable reference of the value was already moved out of the map.

pub fn move_mut(&mut self, key: K) -> Option<&'a mut V>

Moves a mutable reference of the value out of this map.

Panics

Panics if mutable reference of the value was already moved out of the map or the value was already borrowed as immutable.

Trait Implementations

impl<'a, K, V, S> Default for RefKindMap<'a, K, V, S> where
    K: Eq + Hash,
    V: ?Sized + 'a,
    S: Default, 

fn default() -> Self

Constructs an empty map, with the Default value for the hasher.

impl<'a, K, V, S> Extend<(K, &'a V)> for RefKindMap<'a, K, V, S> where
    K: Eq + Hash,
    V: ?Sized + 'a,
    S: BuildHasher, 

fn extend<T: IntoIterator<Item = (K, &'a V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, K, V, S> Extend<(K, &'a mut V)> for RefKindMap<'a, K, V, S> where
    K: Eq + Hash,
    V: ?Sized + 'a,
    S: BuildHasher, 

fn extend<T: IntoIterator<Item = (K, &'a mut V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, K, V, S> FromIterator<(K, &'a V)> for RefKindMap<'a, K, V, S> where
    K: Eq + Hash,
    V: ?Sized + 'a,
    S: BuildHasher + Default, 

fn from_iter<T: IntoIterator<Item = (K, &'a V)>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a, K, V, S> FromIterator<(K, &'a mut V)> for RefKindMap<'a, K, V, S> where
    K: Eq + Hash,
    V: ?Sized + 'a,
    S: BuildHasher + Default, 

fn from_iter<T: IntoIterator<Item = (K, &'a mut V)>>(iter: T) -> Self

Creates a value from an iterator.