Enum indexmap::map::Entry

source ·
pub enum Entry<'a, K, V> {
    Occupied(OccupiedEntry<'a, K, V>),
    Vacant(VacantEntry<'a, K, V>),
}
Expand description

Entry for an existing key-value pair or a vacant location to insert one.

Variants§

§

Occupied(OccupiedEntry<'a, K, V>)

Existing slot with equivalent key.

§

Vacant(VacantEntry<'a, K, V>)

Vacant slot (no equivalent key in the map).

Implementations§

source§

impl<'a, K, V> Entry<'a, K, V>

source

pub fn or_insert(self, default: V) -> &'a mut V

Inserts the given default value in the entry if it is vacant and returns a mutable reference to it. Otherwise a mutable reference to an already existent value is returned.

Computes in O(1) time (amortized average).

source

pub fn or_insert_with<F>(self, call: F) -> &'a mut Vwhere F: FnOnce() -> V,

Inserts the result of the call function in the entry if it is vacant and returns a mutable reference to it. Otherwise a mutable reference to an already existent value is returned.

Computes in O(1) time (amortized average).

source

pub fn or_insert_with_key<F>(self, call: F) -> &'a mut Vwhere F: FnOnce(&K) -> V,

Inserts the result of the call function with a reference to the entry’s key if it is vacant, and returns a mutable reference to the new value. Otherwise a mutable reference to an already existent value is returned.

Computes in O(1) time (amortized average).

source

pub fn key(&self) -> &K

Gets a reference to the entry’s key, either within the map if occupied, or else the new key that was used to find the entry.

source

pub fn index(&self) -> usize

Return the index where the key-value pair exists or will be inserted.

source

pub fn and_modify<F>(self, f: F) -> Selfwhere F: FnOnce(&mut V),

Modifies the entry if it is occupied.

source

pub fn or_default(self) -> &'a mut Vwhere V: Default,

Inserts a default-constructed value in the entry if it is vacant and returns a mutable reference to it. Otherwise a mutable reference to an already existent value is returned.

Computes in O(1) time (amortized average).

Trait Implementations§

source§

impl<K: Debug, V: Debug> Debug for Entry<'_, K, V>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, K, V> RefUnwindSafe for Entry<'a, K, V>where K: RefUnwindSafe, V: RefUnwindSafe,

§

impl<'a, K, V> Send for Entry<'a, K, V>where K: Send, V: Send,

§

impl<'a, K, V> Sync for Entry<'a, K, V>where K: Sync, V: Sync,

§

impl<'a, K, V> Unpin for Entry<'a, K, V>where K: Unpin,

§

impl<'a, K, V> !UnwindSafe for Entry<'a, K, V>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.