# Struct VacantEntry

1.0.0 · Source

    pub struct VacantEntry<'a, K, V, A = Global>where
        A: Allocator + Clone,{ /* private fields */ }

Expand description

A view into a vacant entry in a `BTreeMap`. It is part of the `Entry` enum.

## Implementations§

Source§

### impl<'a, K, V, A> VacantEntry<'a, K, V, A>
where K: Ord, A: Allocator + Clone,

1.10.0 · Source

#### pub fn key(&self) -> &K

Gets a reference to the key that would be used when inserting a value through the VacantEntry.

##### §Examples

    use std::collections::BTreeMap;

    let mut map: BTreeMap<&str, usize> = BTreeMap::new();
    assert_eq!(map.entry("poneyland").key(), &"poneyland");

1.12.0 · Source

#### pub fn into_key(self) -> K

Take ownership of the key.

##### §Examples

    use std::collections::BTreeMap;
    use std::collections::btree_map::Entry;

    let mut map: BTreeMap<&str, usize> = BTreeMap::new();

    if let Entry::Vacant(v) = map.entry("poneyland") {
        v.into_key();
    }

1.0.0 · Source

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

Sets the value of the entry with the `VacantEntry`’s key, and returns a mutable reference to it.

##### §Examples

    use std::collections::BTreeMap;
    use std::collections::btree_map::Entry;

    let mut map: BTreeMap<&str, u32> = BTreeMap::new();

    if let Entry::Vacant(o) = map.entry("poneyland") {
        o.insert(37);
    }
    assert_eq!(map["poneyland"], 37);

Source

#### pub fn insert_entry(self, value: V) -> OccupiedEntry<'a, K, V, A>

🔬This is a nightly-only experimental API. (`btree_entry_insert` #65225)

Sets the value of the entry with the `VacantEntry`’s key, and returns an `OccupiedEntry`.

##### §Examples

    #![feature(btree_entry_insert)]
    use std::collections::BTreeMap;
    use std::collections::btree_map::Entry;

    let mut map: BTreeMap<&str, u32> = BTreeMap::new();

    if let Entry::Vacant(o) = map.entry("poneyland") {
        let entry = o.insert_entry(37);
        assert_eq!(entry.get(), &37);
    }
    assert_eq!(map["poneyland"], 37);

## Trait Implementations§

1.12.0 · Source§

### impl<K, V, A> Debug for VacantEntry<'_, K, V, A>
where K: Debug + Ord, A: Allocator + Clone,

Source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

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

§

### impl<'a, K, V, A> RefUnwindSafe for VacantEntry<'a, K, V, A>
where K: RefUnwindSafe, A: RefUnwindSafe, V: RefUnwindSafe,

§

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

§

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

§

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

§

### impl<'a, K, V, A = Global> !UnwindSafe for VacantEntry<'a, K, V, A>

## 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>,

Source§

#### 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>,

Source§

#### 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.