Gets a reference to the key in the entry.

Examples

use std::collections::HashMap;

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

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

Examples

use std::collections::HashMap;
use std::collections::hash_map::Entry;

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

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

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

Gets a reference to the value in the entry.

Examples

use std::collections::HashMap;
use std::collections::hash_map::Entry;

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

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

Gets a mutable reference to the value in the entry.

Examples

use std::collections::HashMap;
use std::collections::hash_map::Entry;

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

assert_eq!(map["poneyland"], 12);
if let Entry::Occupied(mut o) = map.entry("poneyland") {
     *o.get_mut() += 10;
}

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

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

Examples

use std::collections::HashMap;
use std::collections::hash_map::Entry;

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

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

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

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

Examples

use std::collections::HashMap;
use std::collections::hash_map::Entry;

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

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

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

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

Examples

use std::collections::HashMap;
use std::collections::hash_map::Entry;

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

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

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

Replaces the entry, returning the old key and value. The new key in the hash map will be the key used to create this entry.

Examples

#![feature(map_entry_replace)]
use std::collections::hash_map::{Entry, HashMap};
use std::rc::Rc;

let mut map: HashMap<Rc<String>, u32> = HashMap::new();
map.insert(Rc::new("Stringthing".to_string()), 15);

let my_key = Rc::new("Stringthing".to_string());

if let Entry::Occupied(entry) = map.entry(my_key) {
    // Also replace the key with a handle to our other key.
    let (old_key, old_value): (Rc<String>, u32) = entry.replace_entry(16);
}

Replaces the key in the hash map with the key used to create this entry.

Examples

#![feature(map_entry_replace)]
use std::collections::hash_map::{Entry, HashMap};
use std::rc::Rc;

let mut map: HashMap<Rc<String>, u32> = HashMap::new();
let mut known_strings: Vec<Rc<String>> = Vec::new();

// Initialise known strings, run program, etc.

reclaim_memory(&mut map, &known_strings);

fn reclaim_memory(map: &mut HashMap<Rc<String>, u32>, known_strings: &[Rc<String>] ) {
    for s in known_strings {
        if let Entry::Occupied(entry) = map.entry(s.clone()) {
            // Replaces the entry's key with our version of it in `known_strings`.
            entry.replace_key();
        }
    }
}

Formats the value using the given formatter. Read more