Struct indexmap::map::OccupiedEntry
source · pub struct OccupiedEntry<'a, K, V> { /* private fields */ }Expand description
A view into an occupied entry in a IndexMap.
It is part of the Entry enum.
Implementations§
source§impl<'a, K, V> OccupiedEntry<'a, K, V>
impl<'a, K, V> OccupiedEntry<'a, K, V>
sourcepub fn key(&self) -> &K
pub fn key(&self) -> &K
Gets a reference to the entry’s key in the map.
Note that this is not the key that was used to find the entry. There may be an observable
difference if the key type has any distinguishing features outside of Hash and Eq, like
extra fields or the memory address of an allocation.
sourcepub fn get_mut(&mut self) -> &mut V
pub fn get_mut(&mut self) -> &mut V
Gets a mutable reference to the entry’s value in the map.
If you need a reference which may outlive the destruction of the
Entry value, see into_mut.
sourcepub fn into_mut(self) -> &'a mut V
pub fn into_mut(self) -> &'a mut V
Converts into a mutable reference to the entry’s value in the map, with a lifetime bound to the map itself.
sourcepub fn swap_remove_entry(self) -> (K, V)
pub fn swap_remove_entry(self) -> (K, V)
Remove and return the key, value pair stored in the map for this entry
Like Vec::swap_remove, the pair is removed by swapping it with the
last element of the map and popping it off. This perturbs
the position of what used to be the last element!
Computes in O(1) time (average).
sourcepub fn shift_remove_entry(self) -> (K, V)
pub fn shift_remove_entry(self) -> (K, V)
Remove and return the key, value pair stored in the map for this entry
Like Vec::remove, the pair is removed by shifting all of the
elements that follow it, preserving their relative order.
This perturbs the index of all of those elements!
Computes in O(n) time (average).
source§impl<K, V> OccupiedEntry<'_, K, V>
impl<K, V> OccupiedEntry<'_, K, V>
sourcepub fn insert(&mut self, value: V) -> V
pub fn insert(&mut self, value: V) -> V
Sets the value of the entry to value, and returns the entry’s old value.
sourcepub fn remove(self) -> V
pub fn remove(self) -> V
Remove the key, value pair stored in the map for this entry, and return the value.
NOTE: This is equivalent to .swap_remove().
sourcepub fn swap_remove(self) -> V
pub fn swap_remove(self) -> V
Remove the key, value pair stored in the map for this entry, and return the value.
Like Vec::swap_remove, the pair is removed by swapping it with the
last element of the map and popping it off. This perturbs
the position of what used to be the last element!
Computes in O(1) time (average).
sourcepub fn shift_remove(self) -> V
pub fn shift_remove(self) -> V
Remove the key, value pair stored in the map for this entry, and return the value.
Like Vec::remove, the pair is removed by shifting all of the
elements that follow it, preserving their relative order.
This perturbs the index of all of those elements!
Computes in O(n) time (average).
sourcepub fn remove_entry(self) -> (K, V)
pub fn remove_entry(self) -> (K, V)
Remove and return the key, value pair stored in the map for this entry
NOTE: This is equivalent to .swap_remove_entry().