Struct indexmap::map::VacantEntry

source ·
pub struct VacantEntry<'a, K, V> { /* private fields */ }
Expand description

A view into a vacant entry in an IndexMap. It is part of the Entry enum.

Implementations§

source§

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

source

pub fn index(&self) -> usize

Return the index where a key-value pair may be inserted.

source

pub fn key(&self) -> &K

Gets a reference to the key that was used to find the entry.

source

pub fn into_key(self) -> K

Takes ownership of the key, leaving the entry vacant.

source

pub fn insert(self, value: V) -> &'a mut V

Inserts the entry’s key and the given value into the map, and returns a mutable reference to the value.

source

pub fn insert_sorted(self, value: V) -> (usize, &'a mut V)
where K: Ord,

Inserts the entry’s key and the given value into the map at its ordered position among sorted keys, and returns the new index and a mutable reference to the value.

If the existing keys are not already sorted, then the insertion index is unspecified (like slice::binary_search), but the key-value pair is inserted at that position regardless.

Computes in O(n) time (average).

source

pub fn shift_insert(self, index: usize, value: V) -> &'a mut V

Inserts the entry’s key and the given value into the map at the given index, shifting others to the right, and returns a mutable reference to the value.

Panics if index is out of bounds.

Computes in O(n) time (average).

Trait Implementations§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl<K, V> MutableEntryKey for VacantEntry<'_, K, V>

Opt-in mutable access to VacantEntry keys.

See MutableEntryKey for more information.

§

type Key = K

source§

fn key_mut(&mut self) -> &mut Self::Key

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

Auto Trait Implementations§

§

impl<'a, K, V> Freeze for VacantEntry<'a, K, V>
where K: Freeze,

§

impl<'a, K, V> RefUnwindSafe for VacantEntry<'a, K, V>

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where 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 T
where 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 T
where 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 T
where 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.