From 0df7f00a0430df0d9c14e4c51919062f44aadaad Mon Sep 17 00:00:00 2001 From: Jeroen Bollen Date: Mon, 9 Oct 2017 21:06:20 +0200 Subject: [PATCH] Addressed issues raised in #44286. This commit renames the `replace` function to `replace_entry`, and creates a seperate `replace_key` function for `OccupiedEntry`. The original `replace` function did not solve the use-case where the key needed to be replaced, but not the value. Documentation and naming has also been updated to better reflect what the original replace function does. --- src/libstd/collections/hash/map.rs | 32 +++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/src/libstd/collections/hash/map.rs b/src/libstd/collections/hash/map.rs index 1771e924414..cac6d5ab767 100644 --- a/src/libstd/collections/hash/map.rs +++ b/src/libstd/collections/hash/map.rs @@ -2239,20 +2239,20 @@ impl<'a, K, V> OccupiedEntry<'a, K, V> { self.key.take() } - /// Replaces the entry, returning the old key and value. + /// 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::HashMap; - /// use std::collections::hash_map::Entry; + /// use std::collections::hash_map::{Entry, HashMap}; /// /// let mut map: HashMap = HashMap::new(); /// map.insert("poneyland".to_string(), 15); /// /// if let Entry::Occupied(entry) = map.entry("poneyland".to_string()) { - /// let (old_key, old_value): (String, u32) = entry.replace(16); + /// let (old_key, old_value): (String, u32) = entry.replace_entry(16); /// assert_eq!(old_key, "poneyland"); /// assert_eq!(old_value, 15); /// } @@ -2260,7 +2260,7 @@ impl<'a, K, V> OccupiedEntry<'a, K, V> { /// assert_eq!(map.get("poneyland"), Some(&16)); /// ``` #[unstable(feature = "map_entry_replace", issue = "44286")] - pub fn replace(mut self, value: V) -> (K, V) { + pub fn replace_entry(mut self, value: V) -> (K, V) { let (old_key, old_value) = self.elem.read_mut(); let old_key = mem::replace(old_key, self.key.unwrap()); @@ -2268,6 +2268,28 @@ impl<'a, K, V> OccupiedEntry<'a, K, V> { (old_key, old_value) } + + /// 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}; + /// + /// let mut map: HashMap = HashMap::new(); + /// map.insert("poneyland".to_string(), 15); + /// + /// if let Entry::Occupied(entry) = map.entry("poneyland".to_string()) { + /// let old_key = entry.replace_key(); + /// assert_eq!(old_key, "poneyland"); + /// } + /// ``` + #[unstable(feature = "map_entry_replace", issue = "44286")] + pub fn replace_key(mut self) -> K { + let (old_key, _) = self.elem.read_mut(); + mem::replace(old_key, self.key.unwrap()) + } } impl<'a, K: 'a, V: 'a> VacantEntry<'a, K, V> {