Struct VacantEntry

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

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

Examples

use hashbrown::hash_map::{Entry, HashMap, VacantEntry};

let mut map = HashMap::<&str, i32>::new();

let entry_v: VacantEntry<_, _, _> = match map.entry("a") {
    Entry::Vacant(view) => view,
    Entry::Occupied(_) => unreachable!(),
};
entry_v.insert(10);
assert!(map[&"a"] == 10 && map.len() == 1);

// Nonexistent key (insert and update)
match map.entry("b") {
    Entry::Occupied(_) => unreachable!(),
    Entry::Vacant(view) => {
        let value = view.insert(2);
        assert_eq!(*value, 2);
        *value = 20;
    }
}
assert!(map[&"b"] == 20 && map.len() == 2);

Implementations

impl<'a, K, V, S, A: Allocator> VacantEntry<'a, K, V, S, A>

fn key(&self) -> &K

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

Examples

use hashbrown::HashMap;

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

fn into_key(self) -> K

Take ownership of the key.

Examples

use hashbrown::hash_map::{Entry, HashMap};

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

match map.entry("poneyland") {
    Entry::Occupied(_) => panic!(),
    Entry::Vacant(v) => assert_eq!(v.into_key(), "poneyland"),
}

fn insert(self, value: V) -> &'a mut V
where
    K: Hash,
    S: BuildHasher,

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

Examples

use hashbrown::HashMap;
use hashbrown::hash_map::Entry;

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

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

fn insert_entry(self, value: V) -> OccupiedEntry<'a, K, V, S, A>
where
    K: Hash,
    S: BuildHasher,

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

Examples

use hashbrown::HashMap;
use hashbrown::hash_map::Entry;

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

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

fn into_map(self) -> &'a mut HashMap<K, V, S, A>

Converts the VacantEntry into a mutable reference to the underlying map.

Trait Implementations

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

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

Auto Trait Implementations

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

impl<'a, K, V, S, A> Freeze for VacantEntry<'a, K, V, S, A> where K: Freeze, &'a mut HashMap<K, V, S, A>: Freeze,

impl<'a, K, V, S, A> RefUnwindSafe for VacantEntry<'a, K, V, S, A> where K: RefUnwindSafe, &'a mut HashMap<K, V, S, A>: RefUnwindSafe,

impl<'a, K, V, S, A> Send for VacantEntry<'a, K, V, S, A> where K: Send, &'a mut HashMap<K, V, S, A>: Send,

impl<'a, K, V, S, A> Sync for VacantEntry<'a, K, V, S, A> where K: Sync, &'a mut HashMap<K, V, S, A>: Sync,

impl<'a, K, V, S, A> Unpin for VacantEntry<'a, K, V, S, A> where K: Unpin, &'a mut HashMap<K, V, S, A>: Unpin,

impl<'a, K, V, S, A> UnsafeUnpin for VacantEntry<'a, K, V, S, A> where K: UnsafeUnpin, &'a mut HashMap<K, V, S, A>: UnsafeUnpin,

Blanket Implementations

impl<T> Any for VacantEntry<'a, K, V, S, A> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for VacantEntry<'a, K, V, S, A> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for VacantEntry<'a, K, V, S, A> where T: ?Sized,

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

impl<T> From<T> for VacantEntry<'a, K, V, S, A>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for VacantEntry<'a, K, V, S, A> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

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

impl<T, U> TryFrom<U> for VacantEntry<'a, K, V, S, A> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for VacantEntry<'a, K, V, S, A> where U: TryFrom<T>,

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