Struct RustcOccupiedEntry

Source

pub struct RustcOccupiedEntry<'a, K, V, A = Global>where
    A: Allocator,{
    elem: Bucket<(K, V)>,
    table: &'a mut RawTable<(K, V), A>,
}

Expand description

A view into an occupied entry in a HashMap. It is part of the RustcEntry enum.

Fields§

§elem: Bucket<(K, V)>§table: &'a mut RawTable<(K, V), A>

Implementations§

Source §

impl<'a, K, V, A: Allocator> RustcOccupiedEntry<'a, K, V, A>

Source

pub fn key(&self) -> &K

Gets a reference to the key in the entry.

§Examples

use hashbrown::HashMap;

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

Source

pub fn remove_entry(self) -> (K, V)

Take the ownership of the key and value from the map.

§Examples

use hashbrown::HashMap;
use hashbrown::hash_map::RustcEntry;

let mut map: HashMap<&str, u32> = HashMap::new();
map.rustc_entry("poneyland").or_insert(12);

if let RustcEntry::Occupied(o) = map.rustc_entry("poneyland") {
    // We delete the entry from the map.
    o.remove_entry();
}

assert_eq!(map.contains_key("poneyland"), false);

Source

pub fn get(&self) -> &V

Gets a reference to the value in the entry.

§Examples

use hashbrown::HashMap;
use hashbrown::hash_map::RustcEntry;

let mut map: HashMap<&str, u32> = HashMap::new();
map.rustc_entry("poneyland").or_insert(12);

if let RustcEntry::Occupied(o) = map.rustc_entry("poneyland") {
    assert_eq!(o.get(), &12);
}

Source

pub fn get_mut(&mut self) -> &mut V

Gets a mutable reference to the value in the entry.

If you need a reference to the RustcOccupiedEntry which may outlive the destruction of the RustcEntry value, see into_mut.

§Examples

use hashbrown::HashMap;
use hashbrown::hash_map::RustcEntry;

let mut map: HashMap<&str, u32> = HashMap::new();
map.rustc_entry("poneyland").or_insert(12);

assert_eq!(map["poneyland"], 12);
if let RustcEntry::Occupied(mut o) = map.rustc_entry("poneyland") {
    *o.get_mut() += 10;
    assert_eq!(*o.get(), 22);

    // We can use the same RustcEntry multiple times.
    *o.get_mut() += 2;
}

assert_eq!(map["poneyland"], 24);

Source

pub fn into_mut(self) -> &'a mut V

Converts the RustcOccupiedEntry into a mutable reference to the value in the entry with a lifetime bound to the map itself.

If you need multiple references to the RustcOccupiedEntry, see get_mut.

§Examples

use hashbrown::HashMap;
use hashbrown::hash_map::RustcEntry;

let mut map: HashMap<&str, u32> = HashMap::new();
map.rustc_entry("poneyland").or_insert(12);

assert_eq!(map["poneyland"], 12);
if let RustcEntry::Occupied(o) = map.rustc_entry("poneyland") {
    *o.into_mut() += 10;
}

assert_eq!(map["poneyland"], 22);

Source

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

Sets the value of the entry, and returns the entry’s old value.

§Examples

use hashbrown::HashMap;
use hashbrown::hash_map::RustcEntry;

let mut map: HashMap<&str, u32> = HashMap::new();
map.rustc_entry("poneyland").or_insert(12);

if let RustcEntry::Occupied(mut o) = map.rustc_entry("poneyland") {
    assert_eq!(o.insert(15), 12);
}

assert_eq!(map["poneyland"], 15);

Source

pub fn remove(self) -> V

Takes the value out of the entry, and returns it.

§Examples

use hashbrown::HashMap;
use hashbrown::hash_map::RustcEntry;

let mut map: HashMap<&str, u32> = HashMap::new();
map.rustc_entry("poneyland").or_insert(12);

if let RustcEntry::Occupied(o) = map.rustc_entry("poneyland") {
    assert_eq!(o.remove(), 12);
}

assert_eq!(map.contains_key("poneyland"), false);