-
Notifications
You must be signed in to change notification settings - Fork 13.6k
BTreeMap: refactor Entry out of map.rs into its own file #77851
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+481
−469
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,475 @@ | ||
| use core::fmt::{self, Debug}; | ||
| use core::marker::PhantomData; | ||
| use core::mem; | ||
|
|
||
| use super::super::borrow::DormantMutRef; | ||
| use super::super::node::{marker, Handle, InsertResult::*, NodeRef}; | ||
| use super::BTreeMap; | ||
|
|
||
| use Entry::*; | ||
|
|
||
| /// A view into a single entry in a map, which may either be vacant or occupied. | ||
| /// | ||
| /// This `enum` is constructed from the [`entry`] method on [`BTreeMap`]. | ||
| /// | ||
| /// [`entry`]: BTreeMap::entry | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| pub enum Entry<'a, K: 'a, V: 'a> { | ||
| /// A vacant entry. | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| Vacant(#[stable(feature = "rust1", since = "1.0.0")] VacantEntry<'a, K, V>), | ||
|
|
||
| /// An occupied entry. | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| Occupied(#[stable(feature = "rust1", since = "1.0.0")] OccupiedEntry<'a, K, V>), | ||
| } | ||
|
|
||
| #[stable(feature = "debug_btree_map", since = "1.12.0")] | ||
| impl<K: Debug + Ord, V: Debug> Debug for Entry<'_, K, V> { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| match *self { | ||
| Vacant(ref v) => f.debug_tuple("Entry").field(v).finish(), | ||
| Occupied(ref o) => f.debug_tuple("Entry").field(o).finish(), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// A view into a vacant entry in a `BTreeMap`. | ||
| /// It is part of the [`Entry`] enum. | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| pub struct VacantEntry<'a, K: 'a, V: 'a> { | ||
| pub(super) key: K, | ||
| pub(super) handle: Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>, | ||
| pub(super) dormant_map: DormantMutRef<'a, BTreeMap<K, V>>, | ||
|
|
||
| // Be invariant in `K` and `V` | ||
| pub(super) _marker: PhantomData<&'a mut (K, V)>, | ||
| } | ||
|
|
||
| #[stable(feature = "debug_btree_map", since = "1.12.0")] | ||
| impl<K: Debug + Ord, V> Debug for VacantEntry<'_, K, V> { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| f.debug_tuple("VacantEntry").field(self.key()).finish() | ||
| } | ||
| } | ||
|
|
||
| /// A view into an occupied entry in a `BTreeMap`. | ||
| /// It is part of the [`Entry`] enum. | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| pub struct OccupiedEntry<'a, K: 'a, V: 'a> { | ||
| pub(super) handle: Handle<NodeRef<marker::Mut<'a>, K, V, marker::LeafOrInternal>, marker::KV>, | ||
| pub(super) dormant_map: DormantMutRef<'a, BTreeMap<K, V>>, | ||
|
|
||
| // Be invariant in `K` and `V` | ||
| pub(super) _marker: PhantomData<&'a mut (K, V)>, | ||
| } | ||
|
|
||
| #[stable(feature = "debug_btree_map", since = "1.12.0")] | ||
| impl<K: Debug + Ord, V: Debug> Debug for OccupiedEntry<'_, K, V> { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| f.debug_struct("OccupiedEntry").field("key", self.key()).field("value", self.get()).finish() | ||
| } | ||
| } | ||
|
|
||
| impl<'a, K: Ord, V> Entry<'a, K, V> { | ||
| /// Ensures a value is in the entry by inserting the default if empty, and returns | ||
| /// a mutable reference to the value in the entry. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, usize> = BTreeMap::new(); | ||
| /// map.entry("poneyland").or_insert(12); | ||
| /// | ||
| /// assert_eq!(map["poneyland"], 12); | ||
| /// ``` | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| pub fn or_insert(self, default: V) -> &'a mut V { | ||
| match self { | ||
| Occupied(entry) => entry.into_mut(), | ||
| Vacant(entry) => entry.insert(default), | ||
| } | ||
| } | ||
|
|
||
| /// Ensures a value is in the entry by inserting the result of the default function if empty, | ||
| /// and returns a mutable reference to the value in the entry. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, String> = BTreeMap::new(); | ||
| /// let s = "hoho".to_string(); | ||
| /// | ||
| /// map.entry("poneyland").or_insert_with(|| s); | ||
| /// | ||
| /// assert_eq!(map["poneyland"], "hoho".to_string()); | ||
| /// ``` | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| pub fn or_insert_with<F: FnOnce() -> V>(self, default: F) -> &'a mut V { | ||
| match self { | ||
| Occupied(entry) => entry.into_mut(), | ||
| Vacant(entry) => entry.insert(default()), | ||
| } | ||
| } | ||
|
|
||
| #[unstable(feature = "or_insert_with_key", issue = "71024")] | ||
| /// Ensures a value is in the entry by inserting, if empty, the result of the default function, | ||
| /// which takes the key as its argument, and returns a mutable reference to the value in the | ||
| /// entry. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// #![feature(or_insert_with_key)] | ||
| /// use std::collections::BTreeMap; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, usize> = BTreeMap::new(); | ||
| /// | ||
| /// map.entry("poneyland").or_insert_with_key(|key| key.chars().count()); | ||
| /// | ||
| /// assert_eq!(map["poneyland"], 9); | ||
| /// ``` | ||
| #[inline] | ||
| pub fn or_insert_with_key<F: FnOnce(&K) -> V>(self, default: F) -> &'a mut V { | ||
| match self { | ||
| Occupied(entry) => entry.into_mut(), | ||
| Vacant(entry) => { | ||
| let value = default(entry.key()); | ||
| entry.insert(value) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Returns a reference to this entry's key. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, usize> = BTreeMap::new(); | ||
| /// assert_eq!(map.entry("poneyland").key(), &"poneyland"); | ||
| /// ``` | ||
| #[stable(feature = "map_entry_keys", since = "1.10.0")] | ||
| pub fn key(&self) -> &K { | ||
| match *self { | ||
| Occupied(ref entry) => entry.key(), | ||
| Vacant(ref entry) => entry.key(), | ||
| } | ||
| } | ||
|
|
||
| /// Provides in-place mutable access to an occupied entry before any | ||
| /// potential inserts into the map. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, usize> = BTreeMap::new(); | ||
| /// | ||
| /// map.entry("poneyland") | ||
| /// .and_modify(|e| { *e += 1 }) | ||
| /// .or_insert(42); | ||
| /// assert_eq!(map["poneyland"], 42); | ||
| /// | ||
| /// map.entry("poneyland") | ||
| /// .and_modify(|e| { *e += 1 }) | ||
| /// .or_insert(42); | ||
| /// assert_eq!(map["poneyland"], 43); | ||
| /// ``` | ||
| #[stable(feature = "entry_and_modify", since = "1.26.0")] | ||
| pub fn and_modify<F>(self, f: F) -> Self | ||
| where | ||
| F: FnOnce(&mut V), | ||
| { | ||
| match self { | ||
| Occupied(mut entry) => { | ||
| f(entry.get_mut()); | ||
| Occupied(entry) | ||
| } | ||
| Vacant(entry) => Vacant(entry), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl<'a, K: Ord, V: Default> Entry<'a, K, V> { | ||
| #[stable(feature = "entry_or_default", since = "1.28.0")] | ||
| /// Ensures a value is in the entry by inserting the default value if empty, | ||
| /// and returns a mutable reference to the value in the entry. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, Option<usize>> = BTreeMap::new(); | ||
| /// map.entry("poneyland").or_default(); | ||
| /// | ||
| /// assert_eq!(map["poneyland"], None); | ||
| /// ``` | ||
| pub fn or_default(self) -> &'a mut V { | ||
| match self { | ||
| Occupied(entry) => entry.into_mut(), | ||
| Vacant(entry) => entry.insert(Default::default()), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl<'a, K: Ord, V> VacantEntry<'a, K, V> { | ||
| /// 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"); | ||
| /// ``` | ||
| #[stable(feature = "map_entry_keys", since = "1.10.0")] | ||
| pub fn key(&self) -> &K { | ||
| &self.key | ||
| } | ||
|
|
||
| /// 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(); | ||
| /// } | ||
| /// ``` | ||
| #[stable(feature = "map_entry_recover_keys2", since = "1.12.0")] | ||
| pub fn into_key(self) -> K { | ||
| self.key | ||
| } | ||
|
|
||
| /// 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); | ||
| /// ``` | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| pub fn insert(self, value: V) -> &'a mut V { | ||
| let out_ptr = match self.handle.insert_recursing(self.key, value) { | ||
| (Fit(_), val_ptr) => { | ||
| // Safety: We have consumed self.handle and the handle returned. | ||
| let map = unsafe { self.dormant_map.awaken() }; | ||
| map.length += 1; | ||
| val_ptr | ||
| } | ||
| (Split(ins), val_ptr) => { | ||
| drop(ins.left); | ||
| // Safety: We have consumed self.handle and the reference returned. | ||
| let map = unsafe { self.dormant_map.awaken() }; | ||
| let root = map.root.as_mut().unwrap(); | ||
| root.push_internal_level().push(ins.k, ins.v, ins.right); | ||
| map.length += 1; | ||
| val_ptr | ||
| } | ||
| }; | ||
| // Now that we have finished growing the tree using borrowed references, | ||
| // dereference the pointer to a part of it, that we picked up along the way. | ||
| unsafe { &mut *out_ptr } | ||
| } | ||
| } | ||
|
|
||
| impl<'a, K: Ord, V> OccupiedEntry<'a, K, V> { | ||
| /// Gets a reference to the key in the entry. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, usize> = BTreeMap::new(); | ||
| /// map.entry("poneyland").or_insert(12); | ||
| /// assert_eq!(map.entry("poneyland").key(), &"poneyland"); | ||
| /// ``` | ||
| #[stable(feature = "map_entry_keys", since = "1.10.0")] | ||
| pub fn key(&self) -> &K { | ||
| self.handle.reborrow().into_kv().0 | ||
| } | ||
|
|
||
| /// Take ownership of the key and value from the map. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// use std::collections::btree_map::Entry; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, usize> = BTreeMap::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(); | ||
| /// } | ||
| /// | ||
| /// // If now try to get the value, it will panic: | ||
| /// // println!("{}", map["poneyland"]); | ||
| /// ``` | ||
| #[stable(feature = "map_entry_recover_keys2", since = "1.12.0")] | ||
| pub fn remove_entry(self) -> (K, V) { | ||
| self.remove_kv() | ||
| } | ||
|
|
||
| /// Gets a reference to the value in the entry. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// use std::collections::btree_map::Entry; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, usize> = BTreeMap::new(); | ||
| /// map.entry("poneyland").or_insert(12); | ||
| /// | ||
| /// if let Entry::Occupied(o) = map.entry("poneyland") { | ||
| /// assert_eq!(o.get(), &12); | ||
| /// } | ||
| /// ``` | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| pub fn get(&self) -> &V { | ||
| self.handle.reborrow().into_kv().1 | ||
| } | ||
|
|
||
| /// Gets a mutable reference to the value in the entry. | ||
| /// | ||
| /// If you need a reference to the `OccupiedEntry` that may outlive the | ||
| /// destruction of the `Entry` value, see [`into_mut`]. | ||
| /// | ||
| /// [`into_mut`]: OccupiedEntry::into_mut | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// use std::collections::btree_map::Entry; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, usize> = BTreeMap::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!(*o.get(), 22); | ||
| /// | ||
| /// // We can use the same Entry multiple times. | ||
| /// *o.get_mut() += 2; | ||
| /// } | ||
| /// assert_eq!(map["poneyland"], 24); | ||
| /// ``` | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| pub fn get_mut(&mut self) -> &mut V { | ||
| self.handle.kv_mut().1 | ||
| } | ||
|
|
||
| /// Converts the entry into a mutable reference to its value. | ||
| /// | ||
| /// If you need multiple references to the `OccupiedEntry`, see [`get_mut`]. | ||
| /// | ||
| /// [`get_mut`]: OccupiedEntry::get_mut | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// use std::collections::btree_map::Entry; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, usize> = BTreeMap::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); | ||
| /// ``` | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| pub fn into_mut(self) -> &'a mut V { | ||
| self.handle.into_val_mut() | ||
| } | ||
|
|
||
| /// Sets the value of the entry with the `OccupiedEntry`'s key, | ||
| /// and returns the entry's old value. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// use std::collections::btree_map::Entry; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, usize> = BTreeMap::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); | ||
| /// ``` | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| pub fn insert(&mut self, value: V) -> V { | ||
| mem::replace(self.get_mut(), value) | ||
| } | ||
|
|
||
| /// Takes the value of the entry out of the map, and returns it. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use std::collections::BTreeMap; | ||
| /// use std::collections::btree_map::Entry; | ||
| /// | ||
| /// let mut map: BTreeMap<&str, usize> = BTreeMap::new(); | ||
| /// map.entry("poneyland").or_insert(12); | ||
| /// | ||
| /// if let Entry::Occupied(o) = map.entry("poneyland") { | ||
| /// assert_eq!(o.remove(), 12); | ||
| /// } | ||
| /// // If we try to get "poneyland"'s value, it'll panic: | ||
| /// // println!("{}", map["poneyland"]); | ||
| /// ``` | ||
| #[stable(feature = "rust1", since = "1.0.0")] | ||
| pub fn remove(self) -> V { | ||
| self.remove_kv().1 | ||
| } | ||
|
|
||
| // Body of `remove_entry`, separate to keep the above implementations short. | ||
| pub(super) fn remove_kv(self) -> (K, V) { | ||
| let mut emptied_internal_root = false; | ||
| let (old_kv, _) = self.handle.remove_kv_tracking(|| emptied_internal_root = true); | ||
| // SAFETY: we consumed the intermediate root borrow, `self.handle`. | ||
| let map = unsafe { self.dormant_map.awaken() }; | ||
| map.length -= 1; | ||
| if emptied_internal_root { | ||
| let root = map.root.as_mut().unwrap(); | ||
| root.pop_internal_level(); | ||
| } | ||
| old_kv | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we make it more explicit and not use
use Entry::*?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think so, in this file I think it's pretty clear that
VacantandOccupiedare variants ofEntry. I don't think addingEntry::in front of them is really worth it.In
map.rsit may make more sense to remove the glob import, given that there's only 2 uses each of the unqualified variant names