1 use core::borrow::Borrow;
2 use core::cmp::Ordering;
4 use core::hash::{Hash, Hasher};
5 use core::iter::{FromIterator, FusedIterator, Peekable};
6 use core::marker::PhantomData;
7 use core::mem::{self, ManuallyDrop};
8 use core::ops::Bound::{Excluded, Included, Unbounded};
9 use core::ops::{Index, RangeBounds};
12 use super::node::{self, marker, ForceResult::*, Handle, InsertResult::*, NodeRef};
13 use super::search::{self, SearchResult::*};
14 use super::unwrap_unchecked;
17 use UnderflowResult::*;
19 /// A map based on a B-Tree.
21 /// B-Trees represent a fundamental compromise between cache-efficiency and actually minimizing
22 /// the amount of work performed in a search. In theory, a binary search tree (BST) is the optimal
23 /// choice for a sorted map, as a perfectly balanced BST performs the theoretical minimum amount of
24 /// comparisons necessary to find an element (log<sub>2</sub>n). However, in practice the way this
25 /// is done is *very* inefficient for modern computer architectures. In particular, every element
26 /// is stored in its own individually heap-allocated node. This means that every single insertion
27 /// triggers a heap-allocation, and every single comparison should be a cache-miss. Since these
28 /// are both notably expensive things to do in practice, we are forced to at very least reconsider
31 /// A B-Tree instead makes each node contain B-1 to 2B-1 elements in a contiguous array. By doing
32 /// this, we reduce the number of allocations by a factor of B, and improve cache efficiency in
33 /// searches. However, this does mean that searches will have to do *more* comparisons on average.
34 /// The precise number of comparisons depends on the node search strategy used. For optimal cache
35 /// efficiency, one could search the nodes linearly. For optimal comparisons, one could search
36 /// the node using binary search. As a compromise, one could also perform a linear search
37 /// that initially only checks every i<sup>th</sup> element for some choice of i.
39 /// Currently, our implementation simply performs naive linear search. This provides excellent
40 /// performance on *small* nodes of elements which are cheap to compare. However in the future we
41 /// would like to further explore choosing the optimal search strategy based on the choice of B,
42 /// and possibly other factors. Using linear search, searching for a random element is expected
43 /// to take O(B * log(n)) comparisons, which is generally worse than a BST. In practice,
44 /// however, performance is excellent.
46 /// It is a logic error for a key to be modified in such a way that the key's ordering relative to
47 /// any other key, as determined by the [`Ord`] trait, changes while it is in the map. This is
48 /// normally only possible through [`Cell`], [`RefCell`], global state, I/O, or unsafe code.
50 /// [`Ord`]: ../../std/cmp/trait.Ord.html
51 /// [`Cell`]: ../../std/cell/struct.Cell.html
52 /// [`RefCell`]: ../../std/cell/struct.RefCell.html
57 /// use std::collections::BTreeMap;
59 /// // type inference lets us omit an explicit type signature (which
60 /// // would be `BTreeMap<&str, &str>` in this example).
61 /// let mut movie_reviews = BTreeMap::new();
63 /// // review some movies.
64 /// movie_reviews.insert("Office Space", "Deals with real issues in the workplace.");
65 /// movie_reviews.insert("Pulp Fiction", "Masterpiece.");
66 /// movie_reviews.insert("The Godfather", "Very enjoyable.");
67 /// movie_reviews.insert("The Blues Brothers", "Eye lyked it a lot.");
69 /// // check for a specific one.
70 /// if !movie_reviews.contains_key("Les Misérables") {
71 /// println!("We've got {} reviews, but Les Misérables ain't one.",
72 /// movie_reviews.len());
75 /// // oops, this review has a lot of spelling mistakes, let's delete it.
76 /// movie_reviews.remove("The Blues Brothers");
78 /// // look up the values associated with some keys.
79 /// let to_find = ["Up!", "Office Space"];
80 /// for movie in &to_find {
81 /// match movie_reviews.get(movie) {
82 /// Some(review) => println!("{}: {}", movie, review),
83 /// None => println!("{} is unreviewed.", movie)
87 /// // Look up the value for a key (will panic if the key is not found).
88 /// println!("Movie review: {}", movie_reviews["Office Space"]);
90 /// // iterate over everything.
91 /// for (movie, review) in &movie_reviews {
92 /// println!("{}: \"{}\"", movie, review);
96 /// `BTreeMap` also implements an [`Entry API`](#method.entry), which allows
97 /// for more complex methods of getting, setting, updating and removing keys and
101 /// use std::collections::BTreeMap;
103 /// // type inference lets us omit an explicit type signature (which
104 /// // would be `BTreeMap<&str, u8>` in this example).
105 /// let mut player_stats = BTreeMap::new();
107 /// fn random_stat_buff() -> u8 {
108 /// // could actually return some random value here - let's just return
109 /// // some fixed value for now
113 /// // insert a key only if it doesn't already exist
114 /// player_stats.entry("health").or_insert(100);
116 /// // insert a key using a function that provides a new value only if it
117 /// // doesn't already exist
118 /// player_stats.entry("defence").or_insert_with(random_stat_buff);
120 /// // update a key, guarding against the key possibly not being set
121 /// let stat = player_stats.entry("attack").or_insert(100);
122 /// *stat += random_stat_buff();
124 #[stable(feature = "rust1", since = "1.0.0")]
125 pub struct BTreeMap<K, V> {
126 root: Option<node::Root<K, V>>,
130 #[stable(feature = "btree_drop", since = "1.7.0")]
131 unsafe impl<#[may_dangle] K, #[may_dangle] V> Drop for BTreeMap<K, V> {
134 drop(ptr::read(self).into_iter());
139 #[stable(feature = "rust1", since = "1.0.0")]
140 impl<K: Clone, V: Clone> Clone for BTreeMap<K, V> {
141 fn clone(&self) -> BTreeMap<K, V> {
142 fn clone_subtree<'a, K: Clone, V: Clone>(
143 node: node::NodeRef<marker::Immut<'a>, K, V, marker::LeafOrInternal>,
151 let mut out_tree = BTreeMap { root: Some(node::Root::new_leaf()), length: 0 };
154 let root = out_tree.root.as_mut().unwrap();
155 let mut out_node = match root.as_mut().force() {
157 Internal(_) => unreachable!(),
160 let mut in_edge = leaf.first_edge();
161 while let Ok(kv) = in_edge.right_kv() {
162 let (k, v) = kv.into_kv();
163 in_edge = kv.right_edge();
165 out_node.push(k.clone(), v.clone());
166 out_tree.length += 1;
172 Internal(internal) => {
173 let mut out_tree = clone_subtree(internal.first_edge().descend());
174 out_tree.ensure_root_is_owned();
177 // Ideally we'd use the return of ensure_root_is_owned
178 // instead of re-unwrapping here but unfortunately that
179 // borrows all of out_tree and we need access to the
181 let mut out_node = out_tree.root.as_mut().unwrap().push_level();
182 let mut in_edge = internal.first_edge();
183 while let Ok(kv) = in_edge.right_kv() {
184 let (k, v) = kv.into_kv();
185 in_edge = kv.right_edge();
187 let k = (*k).clone();
188 let v = (*v).clone();
189 let subtree = clone_subtree(in_edge.descend());
191 // We can't destructure subtree directly
192 // because BTreeMap implements Drop
193 let (subroot, sublength) = unsafe {
194 let subtree = ManuallyDrop::new(subtree);
195 let root = ptr::read(&subtree.root);
196 let length = subtree.length;
200 out_node.push(k, v, subroot.unwrap_or_else(node::Root::new_leaf));
201 out_tree.length += 1 + sublength;
211 // Ideally we'd call `BTreeMap::new` here, but that has the `K:
212 // Ord` constraint, which this method lacks.
213 BTreeMap { root: None, length: 0 }
215 clone_subtree(self.root.as_ref().unwrap().as_ref())
220 impl<K, Q: ?Sized> super::Recover<Q> for BTreeMap<K, ()>
227 fn get(&self, key: &Q) -> Option<&K> {
228 match search::search_tree(self.root.as_ref()?.as_ref(), key) {
229 Found(handle) => Some(handle.into_kv().0),
234 fn take(&mut self, key: &Q) -> Option<K> {
235 match search::search_tree(self.root.as_mut()?.as_mut(), key) {
236 Found(handle) => Some(
237 OccupiedEntry { handle, length: &mut self.length, _marker: PhantomData }
245 fn replace(&mut self, key: K) -> Option<K> {
246 self.ensure_root_is_owned();
247 match search::search_tree::<marker::Mut<'_>, K, (), K>(self.root.as_mut()?.as_mut(), &key) {
248 Found(handle) => Some(mem::replace(handle.into_kv_mut().0, key)),
250 VacantEntry { key, handle, length: &mut self.length, _marker: PhantomData }
258 /// An iterator over the entries of a `BTreeMap`.
260 /// This `struct` is created by the [`iter`] method on [`BTreeMap`]. See its
261 /// documentation for more.
263 /// [`iter`]: struct.BTreeMap.html#method.iter
264 /// [`BTreeMap`]: struct.BTreeMap.html
265 #[stable(feature = "rust1", since = "1.0.0")]
266 pub struct Iter<'a, K: 'a, V: 'a> {
267 range: Range<'a, K, V>,
271 #[stable(feature = "collection_debug", since = "1.17.0")]
272 impl<K: fmt::Debug, V: fmt::Debug> fmt::Debug for Iter<'_, K, V> {
273 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
274 f.debug_list().entries(self.clone()).finish()
278 /// A mutable iterator over the entries of a `BTreeMap`.
280 /// This `struct` is created by the [`iter_mut`] method on [`BTreeMap`]. See its
281 /// documentation for more.
283 /// [`iter_mut`]: struct.BTreeMap.html#method.iter_mut
284 /// [`BTreeMap`]: struct.BTreeMap.html
285 #[stable(feature = "rust1", since = "1.0.0")]
287 pub struct IterMut<'a, K: 'a, V: 'a> {
288 range: RangeMut<'a, K, V>,
292 /// An owning iterator over the entries of a `BTreeMap`.
294 /// This `struct` is created by the [`into_iter`] method on [`BTreeMap`]
295 /// (provided by the `IntoIterator` trait). See its documentation for more.
297 /// [`into_iter`]: struct.BTreeMap.html#method.into_iter
298 /// [`BTreeMap`]: struct.BTreeMap.html
299 #[stable(feature = "rust1", since = "1.0.0")]
300 pub struct IntoIter<K, V> {
301 front: Option<Handle<NodeRef<marker::Owned, K, V, marker::Leaf>, marker::Edge>>,
302 back: Option<Handle<NodeRef<marker::Owned, K, V, marker::Leaf>, marker::Edge>>,
306 #[stable(feature = "collection_debug", since = "1.17.0")]
307 impl<K: fmt::Debug, V: fmt::Debug> fmt::Debug for IntoIter<K, V> {
308 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
310 front: self.front.as_ref().map(|f| f.reborrow()),
311 back: self.back.as_ref().map(|b| b.reborrow()),
313 f.debug_list().entries(range).finish()
317 /// An iterator over the keys of a `BTreeMap`.
319 /// This `struct` is created by the [`keys`] method on [`BTreeMap`]. See its
320 /// documentation for more.
322 /// [`keys`]: struct.BTreeMap.html#method.keys
323 /// [`BTreeMap`]: struct.BTreeMap.html
324 #[stable(feature = "rust1", since = "1.0.0")]
325 pub struct Keys<'a, K: 'a, V: 'a> {
326 inner: Iter<'a, K, V>,
329 #[stable(feature = "collection_debug", since = "1.17.0")]
330 impl<K: fmt::Debug, V> fmt::Debug for Keys<'_, K, V> {
331 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
332 f.debug_list().entries(self.clone()).finish()
336 /// An iterator over the values of a `BTreeMap`.
338 /// This `struct` is created by the [`values`] method on [`BTreeMap`]. See its
339 /// documentation for more.
341 /// [`values`]: struct.BTreeMap.html#method.values
342 /// [`BTreeMap`]: struct.BTreeMap.html
343 #[stable(feature = "rust1", since = "1.0.0")]
344 pub struct Values<'a, K: 'a, V: 'a> {
345 inner: Iter<'a, K, V>,
348 #[stable(feature = "collection_debug", since = "1.17.0")]
349 impl<K, V: fmt::Debug> fmt::Debug for Values<'_, K, V> {
350 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
351 f.debug_list().entries(self.clone()).finish()
355 /// A mutable iterator over the values of a `BTreeMap`.
357 /// This `struct` is created by the [`values_mut`] method on [`BTreeMap`]. See its
358 /// documentation for more.
360 /// [`values_mut`]: struct.BTreeMap.html#method.values_mut
361 /// [`BTreeMap`]: struct.BTreeMap.html
362 #[stable(feature = "map_values_mut", since = "1.10.0")]
364 pub struct ValuesMut<'a, K: 'a, V: 'a> {
365 inner: IterMut<'a, K, V>,
368 /// An iterator over a sub-range of entries in a `BTreeMap`.
370 /// This `struct` is created by the [`range`] method on [`BTreeMap`]. See its
371 /// documentation for more.
373 /// [`range`]: struct.BTreeMap.html#method.range
374 /// [`BTreeMap`]: struct.BTreeMap.html
375 #[stable(feature = "btree_range", since = "1.17.0")]
376 pub struct Range<'a, K: 'a, V: 'a> {
377 front: Option<Handle<NodeRef<marker::Immut<'a>, K, V, marker::Leaf>, marker::Edge>>,
378 back: Option<Handle<NodeRef<marker::Immut<'a>, K, V, marker::Leaf>, marker::Edge>>,
381 #[stable(feature = "collection_debug", since = "1.17.0")]
382 impl<K: fmt::Debug, V: fmt::Debug> fmt::Debug for Range<'_, K, V> {
383 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
384 f.debug_list().entries(self.clone()).finish()
388 /// A mutable iterator over a sub-range of entries in a `BTreeMap`.
390 /// This `struct` is created by the [`range_mut`] method on [`BTreeMap`]. See its
391 /// documentation for more.
393 /// [`range_mut`]: struct.BTreeMap.html#method.range_mut
394 /// [`BTreeMap`]: struct.BTreeMap.html
395 #[stable(feature = "btree_range", since = "1.17.0")]
396 pub struct RangeMut<'a, K: 'a, V: 'a> {
397 front: Option<Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>>,
398 back: Option<Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>>,
400 // Be invariant in `K` and `V`
401 _marker: PhantomData<&'a mut (K, V)>,
404 #[stable(feature = "collection_debug", since = "1.17.0")]
405 impl<K: fmt::Debug, V: fmt::Debug> fmt::Debug for RangeMut<'_, K, V> {
406 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
408 front: self.front.as_ref().map(|f| f.reborrow()),
409 back: self.back.as_ref().map(|b| b.reborrow()),
411 f.debug_list().entries(range).finish()
415 /// A view into a single entry in a map, which may either be vacant or occupied.
417 /// This `enum` is constructed from the [`entry`] method on [`BTreeMap`].
419 /// [`BTreeMap`]: struct.BTreeMap.html
420 /// [`entry`]: struct.BTreeMap.html#method.entry
421 #[stable(feature = "rust1", since = "1.0.0")]
422 pub enum Entry<'a, K: 'a, V: 'a> {
424 #[stable(feature = "rust1", since = "1.0.0")]
425 Vacant(#[stable(feature = "rust1", since = "1.0.0")] VacantEntry<'a, K, V>),
427 /// An occupied entry.
428 #[stable(feature = "rust1", since = "1.0.0")]
429 Occupied(#[stable(feature = "rust1", since = "1.0.0")] OccupiedEntry<'a, K, V>),
432 #[stable(feature = "debug_btree_map", since = "1.12.0")]
433 impl<K: Debug + Ord, V: Debug> Debug for Entry<'_, K, V> {
434 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
436 Vacant(ref v) => f.debug_tuple("Entry").field(v).finish(),
437 Occupied(ref o) => f.debug_tuple("Entry").field(o).finish(),
442 /// A view into a vacant entry in a `BTreeMap`.
443 /// It is part of the [`Entry`] enum.
445 /// [`Entry`]: enum.Entry.html
446 #[stable(feature = "rust1", since = "1.0.0")]
447 pub struct VacantEntry<'a, K: 'a, V: 'a> {
449 handle: Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>,
450 length: &'a mut usize,
452 // Be invariant in `K` and `V`
453 _marker: PhantomData<&'a mut (K, V)>,
456 #[stable(feature = "debug_btree_map", since = "1.12.0")]
457 impl<K: Debug + Ord, V> Debug for VacantEntry<'_, K, V> {
458 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
459 f.debug_tuple("VacantEntry").field(self.key()).finish()
463 /// A view into an occupied entry in a `BTreeMap`.
464 /// It is part of the [`Entry`] enum.
466 /// [`Entry`]: enum.Entry.html
467 #[stable(feature = "rust1", since = "1.0.0")]
468 pub struct OccupiedEntry<'a, K: 'a, V: 'a> {
469 handle: Handle<NodeRef<marker::Mut<'a>, K, V, marker::LeafOrInternal>, marker::KV>,
471 length: &'a mut usize,
473 // Be invariant in `K` and `V`
474 _marker: PhantomData<&'a mut (K, V)>,
477 #[stable(feature = "debug_btree_map", since = "1.12.0")]
478 impl<K: Debug + Ord, V: Debug> Debug for OccupiedEntry<'_, K, V> {
479 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
480 f.debug_struct("OccupiedEntry").field("key", self.key()).field("value", self.get()).finish()
484 // An iterator for merging two sorted sequences into one
485 struct MergeIter<K, V, I: Iterator<Item = (K, V)>> {
490 impl<K: Ord, V> BTreeMap<K, V> {
491 /// Makes a new empty BTreeMap.
493 /// Does not allocate anything on its own.
500 /// use std::collections::BTreeMap;
502 /// let mut map = BTreeMap::new();
504 /// // entries can now be inserted into the empty map
505 /// map.insert(1, "a");
507 #[stable(feature = "rust1", since = "1.0.0")]
508 #[rustc_const_unstable(feature = "const_btree_new", issue = "71835")]
509 pub const fn new() -> BTreeMap<K, V> {
510 BTreeMap { root: None, length: 0 }
513 /// Clears the map, removing all elements.
520 /// use std::collections::BTreeMap;
522 /// let mut a = BTreeMap::new();
523 /// a.insert(1, "a");
525 /// assert!(a.is_empty());
527 #[stable(feature = "rust1", since = "1.0.0")]
528 pub fn clear(&mut self) {
529 *self = BTreeMap::new();
532 /// Returns a reference to the value corresponding to the key.
534 /// The key may be any borrowed form of the map's key type, but the ordering
535 /// on the borrowed form *must* match the ordering on the key type.
542 /// use std::collections::BTreeMap;
544 /// let mut map = BTreeMap::new();
545 /// map.insert(1, "a");
546 /// assert_eq!(map.get(&1), Some(&"a"));
547 /// assert_eq!(map.get(&2), None);
549 #[stable(feature = "rust1", since = "1.0.0")]
550 pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<&V>
555 match search::search_tree(self.root.as_ref()?.as_ref(), key) {
556 Found(handle) => Some(handle.into_kv().1),
561 /// Returns the key-value pair corresponding to the supplied key.
563 /// The supplied key may be any borrowed form of the map's key type, but the ordering
564 /// on the borrowed form *must* match the ordering on the key type.
569 /// use std::collections::BTreeMap;
571 /// let mut map = BTreeMap::new();
572 /// map.insert(1, "a");
573 /// assert_eq!(map.get_key_value(&1), Some((&1, &"a")));
574 /// assert_eq!(map.get_key_value(&2), None);
576 #[stable(feature = "map_get_key_value", since = "1.40.0")]
577 pub fn get_key_value<Q: ?Sized>(&self, k: &Q) -> Option<(&K, &V)>
582 match search::search_tree(self.root.as_ref()?.as_ref(), k) {
583 Found(handle) => Some(handle.into_kv()),
588 /// Returns the first key-value pair in the map.
589 /// The key in this pair is the minimum key in the map.
596 /// #![feature(map_first_last)]
597 /// use std::collections::BTreeMap;
599 /// let mut map = BTreeMap::new();
600 /// assert_eq!(map.first_key_value(), None);
601 /// map.insert(1, "b");
602 /// map.insert(2, "a");
603 /// assert_eq!(map.first_key_value(), Some((&1, &"b")));
605 #[unstable(feature = "map_first_last", issue = "62924")]
606 pub fn first_key_value(&self) -> Option<(&K, &V)> {
607 let front = self.root.as_ref()?.as_ref().first_leaf_edge();
608 front.right_kv().ok().map(Handle::into_kv)
611 /// Returns the first entry in the map for in-place manipulation.
612 /// The key of this entry is the minimum key in the map.
617 /// #![feature(map_first_last)]
618 /// use std::collections::BTreeMap;
620 /// let mut map = BTreeMap::new();
621 /// map.insert(1, "a");
622 /// map.insert(2, "b");
623 /// if let Some(mut entry) = map.first_entry() {
624 /// if *entry.key() > 0 {
625 /// entry.insert("first");
628 /// assert_eq!(*map.get(&1).unwrap(), "first");
629 /// assert_eq!(*map.get(&2).unwrap(), "b");
631 #[unstable(feature = "map_first_last", issue = "62924")]
632 pub fn first_entry(&mut self) -> Option<OccupiedEntry<'_, K, V>> {
633 let front = self.root.as_mut()?.as_mut().first_leaf_edge();
634 let kv = front.right_kv().ok()?;
636 handle: kv.forget_node_type(),
637 length: &mut self.length,
638 _marker: PhantomData,
642 /// Removes and returns the first element in the map.
643 /// The key of this element is the minimum key that was in the map.
647 /// Draining elements in ascending order, while keeping a usable map each iteration.
650 /// #![feature(map_first_last)]
651 /// use std::collections::BTreeMap;
653 /// let mut map = BTreeMap::new();
654 /// map.insert(1, "a");
655 /// map.insert(2, "b");
656 /// while let Some((key, _val)) = map.pop_first() {
657 /// assert!(map.iter().all(|(k, _v)| *k > key));
659 /// assert!(map.is_empty());
661 #[unstable(feature = "map_first_last", issue = "62924")]
662 pub fn pop_first(&mut self) -> Option<(K, V)> {
663 self.first_entry().map(|entry| entry.remove_entry())
666 /// Returns the last key-value pair in the map.
667 /// The key in this pair is the maximum key in the map.
674 /// #![feature(map_first_last)]
675 /// use std::collections::BTreeMap;
677 /// let mut map = BTreeMap::new();
678 /// map.insert(1, "b");
679 /// map.insert(2, "a");
680 /// assert_eq!(map.last_key_value(), Some((&2, &"a")));
682 #[unstable(feature = "map_first_last", issue = "62924")]
683 pub fn last_key_value(&self) -> Option<(&K, &V)> {
684 let back = self.root.as_ref()?.as_ref().last_leaf_edge();
685 back.left_kv().ok().map(Handle::into_kv)
688 /// Returns the last entry in the map for in-place manipulation.
689 /// The key of this entry is the maximum key in the map.
694 /// #![feature(map_first_last)]
695 /// use std::collections::BTreeMap;
697 /// let mut map = BTreeMap::new();
698 /// map.insert(1, "a");
699 /// map.insert(2, "b");
700 /// if let Some(mut entry) = map.last_entry() {
701 /// if *entry.key() > 0 {
702 /// entry.insert("last");
705 /// assert_eq!(*map.get(&1).unwrap(), "a");
706 /// assert_eq!(*map.get(&2).unwrap(), "last");
708 #[unstable(feature = "map_first_last", issue = "62924")]
709 pub fn last_entry(&mut self) -> Option<OccupiedEntry<'_, K, V>> {
710 let back = self.root.as_mut()?.as_mut().last_leaf_edge();
711 let kv = back.left_kv().ok()?;
713 handle: kv.forget_node_type(),
714 length: &mut self.length,
715 _marker: PhantomData,
719 /// Removes and returns the last element in the map.
720 /// The key of this element is the maximum key that was in the map.
724 /// Draining elements in descending order, while keeping a usable map each iteration.
727 /// #![feature(map_first_last)]
728 /// use std::collections::BTreeMap;
730 /// let mut map = BTreeMap::new();
731 /// map.insert(1, "a");
732 /// map.insert(2, "b");
733 /// while let Some((key, _val)) = map.pop_last() {
734 /// assert!(map.iter().all(|(k, _v)| *k < key));
736 /// assert!(map.is_empty());
738 #[unstable(feature = "map_first_last", issue = "62924")]
739 pub fn pop_last(&mut self) -> Option<(K, V)> {
740 self.last_entry().map(|entry| entry.remove_entry())
743 /// Returns `true` if the map contains a value for the specified key.
745 /// The key may be any borrowed form of the map's key type, but the ordering
746 /// on the borrowed form *must* match the ordering on the key type.
753 /// use std::collections::BTreeMap;
755 /// let mut map = BTreeMap::new();
756 /// map.insert(1, "a");
757 /// assert_eq!(map.contains_key(&1), true);
758 /// assert_eq!(map.contains_key(&2), false);
760 #[stable(feature = "rust1", since = "1.0.0")]
761 pub fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool
766 self.get(key).is_some()
769 /// Returns a mutable reference to the value corresponding to the key.
771 /// The key may be any borrowed form of the map's key type, but the ordering
772 /// on the borrowed form *must* match the ordering on the key type.
779 /// use std::collections::BTreeMap;
781 /// let mut map = BTreeMap::new();
782 /// map.insert(1, "a");
783 /// if let Some(x) = map.get_mut(&1) {
786 /// assert_eq!(map[&1], "b");
788 // See `get` for implementation notes, this is basically a copy-paste with mut's added
789 #[stable(feature = "rust1", since = "1.0.0")]
790 pub fn get_mut<Q: ?Sized>(&mut self, key: &Q) -> Option<&mut V>
795 match search::search_tree(self.root.as_mut()?.as_mut(), key) {
796 Found(handle) => Some(handle.into_kv_mut().1),
801 /// Inserts a key-value pair into the map.
803 /// If the map did not have this key present, `None` is returned.
805 /// If the map did have this key present, the value is updated, and the old
806 /// value is returned. The key is not updated, though; this matters for
807 /// types that can be `==` without being identical. See the [module-level
808 /// documentation] for more.
810 /// [module-level documentation]: index.html#insert-and-complex-keys
817 /// use std::collections::BTreeMap;
819 /// let mut map = BTreeMap::new();
820 /// assert_eq!(map.insert(37, "a"), None);
821 /// assert_eq!(map.is_empty(), false);
823 /// map.insert(37, "b");
824 /// assert_eq!(map.insert(37, "c"), Some("b"));
825 /// assert_eq!(map[&37], "c");
827 #[stable(feature = "rust1", since = "1.0.0")]
828 pub fn insert(&mut self, key: K, value: V) -> Option<V> {
829 match self.entry(key) {
830 Occupied(mut entry) => Some(entry.insert(value)),
838 /// Removes a key from the map, returning the value at the key if the key
839 /// was previously in the map.
841 /// The key may be any borrowed form of the map's key type, but the ordering
842 /// on the borrowed form *must* match the ordering on the key type.
849 /// use std::collections::BTreeMap;
851 /// let mut map = BTreeMap::new();
852 /// map.insert(1, "a");
853 /// assert_eq!(map.remove(&1), Some("a"));
854 /// assert_eq!(map.remove(&1), None);
856 #[stable(feature = "rust1", since = "1.0.0")]
857 pub fn remove<Q: ?Sized>(&mut self, key: &Q) -> Option<V>
862 self.remove_entry(key).map(|(_, v)| v)
865 /// Removes a key from the map, returning the stored key and value if the key
866 /// was previously in the map.
868 /// The key may be any borrowed form of the map's key type, but the ordering
869 /// on the borrowed form *must* match the ordering on the key type.
876 /// use std::collections::BTreeMap;
878 /// let mut map = BTreeMap::new();
879 /// map.insert(1, "a");
880 /// assert_eq!(map.remove_entry(&1), Some((1, "a")));
881 /// assert_eq!(map.remove_entry(&1), None);
883 #[stable(feature = "btreemap_remove_entry", since = "1.45.0")]
884 pub fn remove_entry<Q: ?Sized>(&mut self, key: &Q) -> Option<(K, V)>
889 match search::search_tree(self.root.as_mut()?.as_mut(), key) {
890 Found(handle) => Some(
891 OccupiedEntry { handle, length: &mut self.length, _marker: PhantomData }
898 /// Moves all elements from `other` into `Self`, leaving `other` empty.
903 /// use std::collections::BTreeMap;
905 /// let mut a = BTreeMap::new();
906 /// a.insert(1, "a");
907 /// a.insert(2, "b");
908 /// a.insert(3, "c");
910 /// let mut b = BTreeMap::new();
911 /// b.insert(3, "d");
912 /// b.insert(4, "e");
913 /// b.insert(5, "f");
915 /// a.append(&mut b);
917 /// assert_eq!(a.len(), 5);
918 /// assert_eq!(b.len(), 0);
920 /// assert_eq!(a[&1], "a");
921 /// assert_eq!(a[&2], "b");
922 /// assert_eq!(a[&3], "d");
923 /// assert_eq!(a[&4], "e");
924 /// assert_eq!(a[&5], "f");
926 #[stable(feature = "btree_append", since = "1.11.0")]
927 pub fn append(&mut self, other: &mut Self) {
928 // Do we have to append anything at all?
929 if other.is_empty() {
933 // We can just swap `self` and `other` if `self` is empty.
935 mem::swap(self, other);
939 // First, we merge `self` and `other` into a sorted sequence in linear time.
940 let self_iter = mem::take(self).into_iter();
941 let other_iter = mem::take(other).into_iter();
942 let iter = MergeIter { left: self_iter.peekable(), right: other_iter.peekable() };
944 // Second, we build a tree from the sorted sequence in linear time.
945 self.from_sorted_iter(iter);
946 self.fix_right_edge();
949 /// Constructs a double-ended iterator over a sub-range of elements in the map.
950 /// The simplest way is to use the range syntax `min..max`, thus `range(min..max)` will
951 /// yield elements from min (inclusive) to max (exclusive).
952 /// The range may also be entered as `(Bound<T>, Bound<T>)`, so for example
953 /// `range((Excluded(4), Included(10)))` will yield a left-exclusive, right-inclusive
954 /// range from 4 to 10.
958 /// Panics if range `start > end`.
959 /// Panics if range `start == end` and both bounds are `Excluded`.
966 /// use std::collections::BTreeMap;
967 /// use std::ops::Bound::Included;
969 /// let mut map = BTreeMap::new();
970 /// map.insert(3, "a");
971 /// map.insert(5, "b");
972 /// map.insert(8, "c");
973 /// for (&key, &value) in map.range((Included(&4), Included(&8))) {
974 /// println!("{}: {}", key, value);
976 /// assert_eq!(Some((&5, &"b")), map.range(4..).next());
978 #[stable(feature = "btree_range", since = "1.17.0")]
979 pub fn range<T: ?Sized, R>(&self, range: R) -> Range<'_, K, V>
985 if let Some(root) = &self.root {
986 let (f, b) = range_search(root.as_ref(), range);
988 Range { front: Some(f), back: Some(b) }
990 Range { front: None, back: None }
994 /// Constructs a mutable double-ended iterator over a sub-range of elements in the map.
995 /// The simplest way is to use the range syntax `min..max`, thus `range(min..max)` will
996 /// yield elements from min (inclusive) to max (exclusive).
997 /// The range may also be entered as `(Bound<T>, Bound<T>)`, so for example
998 /// `range((Excluded(4), Included(10)))` will yield a left-exclusive, right-inclusive
999 /// range from 4 to 10.
1003 /// Panics if range `start > end`.
1004 /// Panics if range `start == end` and both bounds are `Excluded`.
1011 /// use std::collections::BTreeMap;
1013 /// let mut map: BTreeMap<&str, i32> = ["Alice", "Bob", "Carol", "Cheryl"]
1015 /// .map(|&s| (s, 0))
1017 /// for (_, balance) in map.range_mut("B".."Cheryl") {
1018 /// *balance += 100;
1020 /// for (name, balance) in &map {
1021 /// println!("{} => {}", name, balance);
1024 #[stable(feature = "btree_range", since = "1.17.0")]
1025 pub fn range_mut<T: ?Sized, R>(&mut self, range: R) -> RangeMut<'_, K, V>
1031 if let Some(root) = &mut self.root {
1032 let (f, b) = range_search(root.as_mut(), range);
1034 RangeMut { front: Some(f), back: Some(b), _marker: PhantomData }
1036 RangeMut { front: None, back: None, _marker: PhantomData }
1040 /// Gets the given key's corresponding entry in the map for in-place manipulation.
1047 /// use std::collections::BTreeMap;
1049 /// let mut count: BTreeMap<&str, usize> = BTreeMap::new();
1051 /// // count the number of occurrences of letters in the vec
1052 /// for x in vec!["a","b","a","c","a","b"] {
1053 /// *count.entry(x).or_insert(0) += 1;
1056 /// assert_eq!(count["a"], 3);
1058 #[stable(feature = "rust1", since = "1.0.0")]
1059 pub fn entry(&mut self, key: K) -> Entry<'_, K, V> {
1060 // FIXME(@porglezomp) Avoid allocating if we don't insert
1061 self.ensure_root_is_owned();
1062 match search::search_tree(self.root.as_mut().unwrap().as_mut(), &key) {
1064 Occupied(OccupiedEntry { handle, length: &mut self.length, _marker: PhantomData })
1067 Vacant(VacantEntry { key, handle, length: &mut self.length, _marker: PhantomData })
1072 fn from_sorted_iter<I: Iterator<Item = (K, V)>>(&mut self, iter: I) {
1073 self.ensure_root_is_owned();
1074 let mut cur_node = self.root.as_mut().unwrap().as_mut().last_leaf_edge().into_node();
1075 // Iterate through all key-value pairs, pushing them into nodes at the right level.
1076 for (key, value) in iter {
1077 // Try to push key-value pair into the current leaf node.
1078 if cur_node.len() < node::CAPACITY {
1079 cur_node.push(key, value);
1081 // No space left, go up and push there.
1083 let mut test_node = cur_node.forget_type();
1085 match test_node.ascend() {
1087 let parent = parent.into_node();
1088 if parent.len() < node::CAPACITY {
1089 // Found a node with space left, push here.
1094 test_node = parent.forget_type();
1098 // We are at the top, create a new root node and push there.
1099 open_node = node.into_root_mut().push_level();
1105 // Push key-value pair and new right subtree.
1106 let tree_height = open_node.height() - 1;
1107 let mut right_tree = node::Root::new_leaf();
1108 for _ in 0..tree_height {
1109 right_tree.push_level();
1111 open_node.push(key, value, right_tree);
1113 // Go down to the right-most leaf again.
1114 cur_node = open_node.forget_type().last_leaf_edge().into_node();
1121 fn fix_right_edge(&mut self) {
1122 // Handle underfull nodes, start from the top.
1123 let mut cur_node = self.root.as_mut().unwrap().as_mut();
1124 while let Internal(internal) = cur_node.force() {
1125 // Check if right-most child is underfull.
1126 let mut last_edge = internal.last_edge();
1127 let right_child_len = last_edge.reborrow().descend().len();
1128 if right_child_len < node::MIN_LEN {
1129 // We need to steal.
1130 let mut last_kv = match last_edge.left_kv() {
1132 Err(_) => unreachable!(),
1134 last_kv.bulk_steal_left(node::MIN_LEN - right_child_len);
1135 last_edge = last_kv.right_edge();
1139 cur_node = last_edge.descend();
1143 /// Splits the collection into two at the given key. Returns everything after the given key,
1144 /// including the key.
1151 /// use std::collections::BTreeMap;
1153 /// let mut a = BTreeMap::new();
1154 /// a.insert(1, "a");
1155 /// a.insert(2, "b");
1156 /// a.insert(3, "c");
1157 /// a.insert(17, "d");
1158 /// a.insert(41, "e");
1160 /// let b = a.split_off(&3);
1162 /// assert_eq!(a.len(), 2);
1163 /// assert_eq!(b.len(), 3);
1165 /// assert_eq!(a[&1], "a");
1166 /// assert_eq!(a[&2], "b");
1168 /// assert_eq!(b[&3], "c");
1169 /// assert_eq!(b[&17], "d");
1170 /// assert_eq!(b[&41], "e");
1172 #[stable(feature = "btree_split_off", since = "1.11.0")]
1173 pub fn split_off<Q: ?Sized + Ord>(&mut self, key: &Q) -> Self
1177 if self.is_empty() {
1181 let total_num = self.len();
1183 let mut right = Self::new();
1184 let right_root = right.ensure_root_is_owned();
1185 for _ in 0..(self.root.as_ref().unwrap().as_ref().height()) {
1186 right_root.push_level();
1190 let mut left_node = self.root.as_mut().unwrap().as_mut();
1191 let mut right_node = right.root.as_mut().unwrap().as_mut();
1194 let mut split_edge = match search::search_node(left_node, key) {
1195 // key is going to the right tree
1196 Found(handle) => handle.left_edge(),
1197 GoDown(handle) => handle,
1200 split_edge.move_suffix(&mut right_node);
1202 match (split_edge.force(), right_node.force()) {
1203 (Internal(edge), Internal(node)) => {
1204 left_node = edge.descend();
1205 right_node = node.first_edge().descend();
1207 (Leaf(_), Leaf(_)) => {
1217 self.fix_right_border();
1218 right.fix_left_border();
1220 if self.root.as_ref().unwrap().as_ref().height()
1221 < right.root.as_ref().unwrap().as_ref().height()
1223 self.recalc_length();
1224 right.length = total_num - self.len();
1226 right.recalc_length();
1227 self.length = total_num - right.len();
1233 /// Creates an iterator which uses a closure to determine if an element should be removed.
1235 /// If the closure returns true, the element is removed from the map and yielded.
1236 /// If the closure returns false, or panics, the element remains in the map and will not be
1239 /// Note that `drain_filter` lets you mutate every value in the filter closure, regardless of
1240 /// whether you choose to keep or remove it.
1242 /// If the iterator is only partially consumed or not consumed at all, each of the remaining
1243 /// elements will still be subjected to the closure and removed and dropped if it returns true.
1245 /// It is unspecified how many more elements will be subjected to the closure
1246 /// if a panic occurs in the closure, or a panic occurs while dropping an element,
1247 /// or if the `DrainFilter` value is leaked.
1251 /// Splitting a map into even and odd keys, reusing the original map:
1254 /// #![feature(btree_drain_filter)]
1255 /// use std::collections::BTreeMap;
1257 /// let mut map: BTreeMap<i32, i32> = (0..8).map(|x| (x, x)).collect();
1258 /// let evens: BTreeMap<_, _> = map.drain_filter(|k, _v| k % 2 == 0).collect();
1260 /// assert_eq!(evens.keys().copied().collect::<Vec<_>>(), vec![0, 2, 4, 6]);
1261 /// assert_eq!(odds.keys().copied().collect::<Vec<_>>(), vec![1, 3, 5, 7]);
1263 #[unstable(feature = "btree_drain_filter", issue = "70530")]
1264 pub fn drain_filter<F>(&mut self, pred: F) -> DrainFilter<'_, K, V, F>
1266 F: FnMut(&K, &mut V) -> bool,
1268 DrainFilter { pred, inner: self.drain_filter_inner() }
1270 pub(super) fn drain_filter_inner(&mut self) -> DrainFilterInner<'_, K, V> {
1271 let front = self.root.as_mut().map(|r| r.as_mut().first_leaf_edge());
1272 DrainFilterInner { length: &mut self.length, cur_leaf_edge: front }
1275 /// Calculates the number of elements if it is incorrect.
1276 fn recalc_length(&mut self) {
1277 fn dfs<'a, K, V>(node: NodeRef<marker::Immut<'a>, K, V, marker::LeafOrInternal>) -> usize
1282 let mut res = node.len();
1284 if let Internal(node) = node.force() {
1285 let mut edge = node.first_edge();
1287 res += dfs(edge.reborrow().descend());
1288 match edge.right_kv() {
1290 edge = right_kv.right_edge();
1302 self.length = dfs(self.root.as_ref().unwrap().as_ref());
1305 /// Removes empty levels on the top.
1306 fn fix_top(&mut self) {
1309 let node = self.root.as_ref().unwrap().as_ref();
1310 if node.height() == 0 || node.len() > 0 {
1314 self.root.as_mut().unwrap().pop_level();
1318 fn fix_right_border(&mut self) {
1322 let mut cur_node = self.root.as_mut().unwrap().as_mut();
1324 while let Internal(node) = cur_node.force() {
1325 let mut last_kv = node.last_kv();
1327 if last_kv.can_merge() {
1328 cur_node = last_kv.merge().descend();
1330 let right_len = last_kv.reborrow().right_edge().descend().len();
1331 // `MINLEN + 1` to avoid readjust if merge happens on the next level.
1332 if right_len < node::MIN_LEN + 1 {
1333 last_kv.bulk_steal_left(node::MIN_LEN + 1 - right_len);
1335 cur_node = last_kv.right_edge().descend();
1343 /// The symmetric clone of `fix_right_border`.
1344 fn fix_left_border(&mut self) {
1348 let mut cur_node = self.root.as_mut().unwrap().as_mut();
1350 while let Internal(node) = cur_node.force() {
1351 let mut first_kv = node.first_kv();
1353 if first_kv.can_merge() {
1354 cur_node = first_kv.merge().descend();
1356 let left_len = first_kv.reborrow().left_edge().descend().len();
1357 if left_len < node::MIN_LEN + 1 {
1358 first_kv.bulk_steal_right(node::MIN_LEN + 1 - left_len);
1360 cur_node = first_kv.left_edge().descend();
1369 #[stable(feature = "rust1", since = "1.0.0")]
1370 impl<'a, K: 'a, V: 'a> IntoIterator for &'a BTreeMap<K, V> {
1371 type Item = (&'a K, &'a V);
1372 type IntoIter = Iter<'a, K, V>;
1374 fn into_iter(self) -> Iter<'a, K, V> {
1379 #[stable(feature = "rust1", since = "1.0.0")]
1380 impl<'a, K: 'a, V: 'a> Iterator for Iter<'a, K, V> {
1381 type Item = (&'a K, &'a V);
1383 fn next(&mut self) -> Option<(&'a K, &'a V)> {
1384 if self.length == 0 {
1388 unsafe { Some(self.range.next_unchecked()) }
1392 fn size_hint(&self) -> (usize, Option<usize>) {
1393 (self.length, Some(self.length))
1396 fn last(mut self) -> Option<(&'a K, &'a V)> {
1400 fn min(mut self) -> Option<(&'a K, &'a V)> {
1404 fn max(mut self) -> Option<(&'a K, &'a V)> {
1409 #[stable(feature = "fused", since = "1.26.0")]
1410 impl<K, V> FusedIterator for Iter<'_, K, V> {}
1412 #[stable(feature = "rust1", since = "1.0.0")]
1413 impl<'a, K: 'a, V: 'a> DoubleEndedIterator for Iter<'a, K, V> {
1414 fn next_back(&mut self) -> Option<(&'a K, &'a V)> {
1415 if self.length == 0 {
1419 unsafe { Some(self.range.next_back_unchecked()) }
1424 #[stable(feature = "rust1", since = "1.0.0")]
1425 impl<K, V> ExactSizeIterator for Iter<'_, K, V> {
1426 fn len(&self) -> usize {
1431 #[stable(feature = "rust1", since = "1.0.0")]
1432 impl<K, V> Clone for Iter<'_, K, V> {
1433 fn clone(&self) -> Self {
1434 Iter { range: self.range.clone(), length: self.length }
1438 #[stable(feature = "rust1", since = "1.0.0")]
1439 impl<'a, K: 'a, V: 'a> IntoIterator for &'a mut BTreeMap<K, V> {
1440 type Item = (&'a K, &'a mut V);
1441 type IntoIter = IterMut<'a, K, V>;
1443 fn into_iter(self) -> IterMut<'a, K, V> {
1448 #[stable(feature = "rust1", since = "1.0.0")]
1449 impl<'a, K: 'a, V: 'a> Iterator for IterMut<'a, K, V> {
1450 type Item = (&'a K, &'a mut V);
1452 fn next(&mut self) -> Option<(&'a K, &'a mut V)> {
1453 if self.length == 0 {
1457 let (k, v) = unsafe { self.range.next_unchecked() };
1458 Some((k, v)) // coerce k from `&mut K` to `&K`
1462 fn size_hint(&self) -> (usize, Option<usize>) {
1463 (self.length, Some(self.length))
1466 fn last(mut self) -> Option<(&'a K, &'a mut V)> {
1470 fn min(mut self) -> Option<(&'a K, &'a mut V)> {
1474 fn max(mut self) -> Option<(&'a K, &'a mut V)> {
1479 #[stable(feature = "rust1", since = "1.0.0")]
1480 impl<'a, K: 'a, V: 'a> DoubleEndedIterator for IterMut<'a, K, V> {
1481 fn next_back(&mut self) -> Option<(&'a K, &'a mut V)> {
1482 if self.length == 0 {
1486 let (k, v) = unsafe { self.range.next_back_unchecked() };
1487 Some((k, v)) // coerce k from `&mut K` to `&K`
1492 #[stable(feature = "rust1", since = "1.0.0")]
1493 impl<K, V> ExactSizeIterator for IterMut<'_, K, V> {
1494 fn len(&self) -> usize {
1499 #[stable(feature = "fused", since = "1.26.0")]
1500 impl<K, V> FusedIterator for IterMut<'_, K, V> {}
1502 #[stable(feature = "rust1", since = "1.0.0")]
1503 impl<K, V> IntoIterator for BTreeMap<K, V> {
1505 type IntoIter = IntoIter<K, V>;
1507 fn into_iter(self) -> IntoIter<K, V> {
1508 let mut me = ManuallyDrop::new(self);
1509 if let Some(root) = me.root.take() {
1510 let (f, b) = full_range_search(root.into_ref());
1512 IntoIter { front: Some(f), back: Some(b), length: me.length }
1514 IntoIter { front: None, back: None, length: 0 }
1519 #[stable(feature = "btree_drop", since = "1.7.0")]
1520 impl<K, V> Drop for IntoIter<K, V> {
1521 fn drop(&mut self) {
1522 struct DropGuard<'a, K, V>(&'a mut IntoIter<K, V>);
1524 impl<'a, K, V> Drop for DropGuard<'a, K, V> {
1525 fn drop(&mut self) {
1526 // Continue the same loop we perform below. This only runs when unwinding, so we
1527 // don't have to care about panics this time (they'll abort).
1528 while let Some(_) = self.0.next() {}
1532 unwrap_unchecked(ptr::read(&self.0.front)).into_node().forget_type();
1533 while let Some(parent) = node.deallocate_and_ascend() {
1534 node = parent.into_node().forget_type();
1540 while let Some(pair) = self.next() {
1541 let guard = DropGuard(self);
1547 if let Some(front) = ptr::read(&self.front) {
1548 let mut node = front.into_node().forget_type();
1549 // Most of the nodes have been deallocated while traversing
1550 // but one pile from a leaf up to the root is left standing.
1551 while let Some(parent) = node.deallocate_and_ascend() {
1552 node = parent.into_node().forget_type();
1559 #[stable(feature = "rust1", since = "1.0.0")]
1560 impl<K, V> Iterator for IntoIter<K, V> {
1563 fn next(&mut self) -> Option<(K, V)> {
1564 if self.length == 0 {
1568 Some(unsafe { self.front.as_mut().unwrap().next_unchecked() })
1572 fn size_hint(&self) -> (usize, Option<usize>) {
1573 (self.length, Some(self.length))
1577 #[stable(feature = "rust1", since = "1.0.0")]
1578 impl<K, V> DoubleEndedIterator for IntoIter<K, V> {
1579 fn next_back(&mut self) -> Option<(K, V)> {
1580 if self.length == 0 {
1584 Some(unsafe { self.back.as_mut().unwrap().next_back_unchecked() })
1589 #[stable(feature = "rust1", since = "1.0.0")]
1590 impl<K, V> ExactSizeIterator for IntoIter<K, V> {
1591 fn len(&self) -> usize {
1596 #[stable(feature = "fused", since = "1.26.0")]
1597 impl<K, V> FusedIterator for IntoIter<K, V> {}
1599 #[stable(feature = "rust1", since = "1.0.0")]
1600 impl<'a, K, V> Iterator for Keys<'a, K, V> {
1603 fn next(&mut self) -> Option<&'a K> {
1604 self.inner.next().map(|(k, _)| k)
1607 fn size_hint(&self) -> (usize, Option<usize>) {
1608 self.inner.size_hint()
1611 fn last(mut self) -> Option<&'a K> {
1615 fn min(mut self) -> Option<&'a K> {
1619 fn max(mut self) -> Option<&'a K> {
1624 #[stable(feature = "rust1", since = "1.0.0")]
1625 impl<'a, K, V> DoubleEndedIterator for Keys<'a, K, V> {
1626 fn next_back(&mut self) -> Option<&'a K> {
1627 self.inner.next_back().map(|(k, _)| k)
1631 #[stable(feature = "rust1", since = "1.0.0")]
1632 impl<K, V> ExactSizeIterator for Keys<'_, K, V> {
1633 fn len(&self) -> usize {
1638 #[stable(feature = "fused", since = "1.26.0")]
1639 impl<K, V> FusedIterator for Keys<'_, K, V> {}
1641 #[stable(feature = "rust1", since = "1.0.0")]
1642 impl<K, V> Clone for Keys<'_, K, V> {
1643 fn clone(&self) -> Self {
1644 Keys { inner: self.inner.clone() }
1648 #[stable(feature = "rust1", since = "1.0.0")]
1649 impl<'a, K, V> Iterator for Values<'a, K, V> {
1652 fn next(&mut self) -> Option<&'a V> {
1653 self.inner.next().map(|(_, v)| v)
1656 fn size_hint(&self) -> (usize, Option<usize>) {
1657 self.inner.size_hint()
1660 fn last(mut self) -> Option<&'a V> {
1665 #[stable(feature = "rust1", since = "1.0.0")]
1666 impl<'a, K, V> DoubleEndedIterator for Values<'a, K, V> {
1667 fn next_back(&mut self) -> Option<&'a V> {
1668 self.inner.next_back().map(|(_, v)| v)
1672 #[stable(feature = "rust1", since = "1.0.0")]
1673 impl<K, V> ExactSizeIterator for Values<'_, K, V> {
1674 fn len(&self) -> usize {
1679 #[stable(feature = "fused", since = "1.26.0")]
1680 impl<K, V> FusedIterator for Values<'_, K, V> {}
1682 #[stable(feature = "rust1", since = "1.0.0")]
1683 impl<K, V> Clone for Values<'_, K, V> {
1684 fn clone(&self) -> Self {
1685 Values { inner: self.inner.clone() }
1689 /// An iterator produced by calling `drain_filter` on BTreeMap.
1690 #[unstable(feature = "btree_drain_filter", issue = "70530")]
1691 pub struct DrainFilter<'a, K, V, F>
1695 F: 'a + FnMut(&K, &mut V) -> bool,
1698 inner: DrainFilterInner<'a, K, V>,
1700 /// Most of the implementation of DrainFilter, independent of the type
1701 /// of the predicate, thus also serving for BTreeSet::DrainFilter.
1702 pub(super) struct DrainFilterInner<'a, K: 'a, V: 'a> {
1703 length: &'a mut usize,
1704 cur_leaf_edge: Option<Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>>,
1707 #[unstable(feature = "btree_drain_filter", issue = "70530")]
1708 impl<K, V, F> Drop for DrainFilter<'_, K, V, F>
1710 F: FnMut(&K, &mut V) -> bool,
1712 fn drop(&mut self) {
1713 self.for_each(drop);
1717 #[unstable(feature = "btree_drain_filter", issue = "70530")]
1718 impl<K, V, F> fmt::Debug for DrainFilter<'_, K, V, F>
1722 F: FnMut(&K, &mut V) -> bool,
1724 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1725 f.debug_tuple("DrainFilter").field(&self.inner.peek()).finish()
1729 #[unstable(feature = "btree_drain_filter", issue = "70530")]
1730 impl<K, V, F> Iterator for DrainFilter<'_, K, V, F>
1732 F: FnMut(&K, &mut V) -> bool,
1736 fn next(&mut self) -> Option<(K, V)> {
1737 self.inner.next(&mut self.pred)
1740 fn size_hint(&self) -> (usize, Option<usize>) {
1741 self.inner.size_hint()
1745 impl<'a, K: 'a, V: 'a> DrainFilterInner<'a, K, V> {
1746 /// Allow Debug implementations to predict the next element.
1747 pub(super) fn peek(&self) -> Option<(&K, &V)> {
1748 let edge = self.cur_leaf_edge.as_ref()?;
1749 edge.reborrow().next_kv().ok().map(|kv| kv.into_kv())
1754 ) -> Option<Handle<NodeRef<marker::Mut<'a>, K, V, marker::LeafOrInternal>, marker::KV>> {
1755 let edge = self.cur_leaf_edge.as_ref()?;
1756 unsafe { ptr::read(edge).next_kv().ok() }
1759 /// Implementation of a typical `DrainFilter::next` method, given the predicate.
1760 pub(super) fn next<F>(&mut self, pred: &mut F) -> Option<(K, V)>
1762 F: FnMut(&K, &mut V) -> bool,
1764 while let Some(mut kv) = unsafe { self.next_kv() } {
1765 let (k, v) = kv.kv_mut();
1768 let (k, v, leaf_edge_location) = kv.remove_kv_tracking();
1769 self.cur_leaf_edge = Some(leaf_edge_location);
1770 return Some((k, v));
1772 self.cur_leaf_edge = Some(kv.next_leaf_edge());
1777 /// Implementation of a typical `DrainFilter::size_hint` method.
1778 pub(super) fn size_hint(&self) -> (usize, Option<usize>) {
1779 (0, Some(*self.length))
1783 #[unstable(feature = "btree_drain_filter", issue = "70530")]
1784 impl<K, V, F> FusedIterator for DrainFilter<'_, K, V, F> where F: FnMut(&K, &mut V) -> bool {}
1786 #[stable(feature = "btree_range", since = "1.17.0")]
1787 impl<'a, K, V> Iterator for Range<'a, K, V> {
1788 type Item = (&'a K, &'a V);
1790 fn next(&mut self) -> Option<(&'a K, &'a V)> {
1791 if self.is_empty() { None } else { unsafe { Some(self.next_unchecked()) } }
1794 fn last(mut self) -> Option<(&'a K, &'a V)> {
1798 fn min(mut self) -> Option<(&'a K, &'a V)> {
1802 fn max(mut self) -> Option<(&'a K, &'a V)> {
1807 #[stable(feature = "map_values_mut", since = "1.10.0")]
1808 impl<'a, K, V> Iterator for ValuesMut<'a, K, V> {
1809 type Item = &'a mut V;
1811 fn next(&mut self) -> Option<&'a mut V> {
1812 self.inner.next().map(|(_, v)| v)
1815 fn size_hint(&self) -> (usize, Option<usize>) {
1816 self.inner.size_hint()
1819 fn last(mut self) -> Option<&'a mut V> {
1824 #[stable(feature = "map_values_mut", since = "1.10.0")]
1825 impl<'a, K, V> DoubleEndedIterator for ValuesMut<'a, K, V> {
1826 fn next_back(&mut self) -> Option<&'a mut V> {
1827 self.inner.next_back().map(|(_, v)| v)
1831 #[stable(feature = "map_values_mut", since = "1.10.0")]
1832 impl<K, V> ExactSizeIterator for ValuesMut<'_, K, V> {
1833 fn len(&self) -> usize {
1838 #[stable(feature = "fused", since = "1.26.0")]
1839 impl<K, V> FusedIterator for ValuesMut<'_, K, V> {}
1841 impl<'a, K, V> Range<'a, K, V> {
1842 fn is_empty(&self) -> bool {
1843 self.front == self.back
1846 unsafe fn next_unchecked(&mut self) -> (&'a K, &'a V) {
1847 unsafe { unwrap_unchecked(self.front.as_mut()).next_unchecked() }
1851 #[stable(feature = "btree_range", since = "1.17.0")]
1852 impl<'a, K, V> DoubleEndedIterator for Range<'a, K, V> {
1853 fn next_back(&mut self) -> Option<(&'a K, &'a V)> {
1854 if self.is_empty() { None } else { Some(unsafe { self.next_back_unchecked() }) }
1858 impl<'a, K, V> Range<'a, K, V> {
1859 unsafe fn next_back_unchecked(&mut self) -> (&'a K, &'a V) {
1860 unsafe { unwrap_unchecked(self.back.as_mut()).next_back_unchecked() }
1864 #[stable(feature = "fused", since = "1.26.0")]
1865 impl<K, V> FusedIterator for Range<'_, K, V> {}
1867 #[stable(feature = "btree_range", since = "1.17.0")]
1868 impl<K, V> Clone for Range<'_, K, V> {
1869 fn clone(&self) -> Self {
1870 Range { front: self.front, back: self.back }
1874 #[stable(feature = "btree_range", since = "1.17.0")]
1875 impl<'a, K, V> Iterator for RangeMut<'a, K, V> {
1876 type Item = (&'a K, &'a mut V);
1878 fn next(&mut self) -> Option<(&'a K, &'a mut V)> {
1879 if self.is_empty() {
1882 let (k, v) = unsafe { self.next_unchecked() };
1883 Some((k, v)) // coerce k from `&mut K` to `&K`
1887 fn last(mut self) -> Option<(&'a K, &'a mut V)> {
1891 fn min(mut self) -> Option<(&'a K, &'a mut V)> {
1895 fn max(mut self) -> Option<(&'a K, &'a mut V)> {
1900 impl<'a, K, V> RangeMut<'a, K, V> {
1901 fn is_empty(&self) -> bool {
1902 self.front == self.back
1905 unsafe fn next_unchecked(&mut self) -> (&'a mut K, &'a mut V) {
1906 unsafe { unwrap_unchecked(self.front.as_mut()).next_unchecked() }
1910 #[stable(feature = "btree_range", since = "1.17.0")]
1911 impl<'a, K, V> DoubleEndedIterator for RangeMut<'a, K, V> {
1912 fn next_back(&mut self) -> Option<(&'a K, &'a mut V)> {
1913 if self.is_empty() {
1916 let (k, v) = unsafe { self.next_back_unchecked() };
1917 Some((k, v)) // coerce k from `&mut K` to `&K`
1922 #[stable(feature = "fused", since = "1.26.0")]
1923 impl<K, V> FusedIterator for RangeMut<'_, K, V> {}
1925 impl<'a, K, V> RangeMut<'a, K, V> {
1926 unsafe fn next_back_unchecked(&mut self) -> (&'a mut K, &'a mut V) {
1927 unsafe { unwrap_unchecked(self.back.as_mut()).next_back_unchecked() }
1931 #[stable(feature = "rust1", since = "1.0.0")]
1932 impl<K: Ord, V> FromIterator<(K, V)> for BTreeMap<K, V> {
1933 fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> BTreeMap<K, V> {
1934 let mut map = BTreeMap::new();
1940 #[stable(feature = "rust1", since = "1.0.0")]
1941 impl<K: Ord, V> Extend<(K, V)> for BTreeMap<K, V> {
1943 fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T) {
1944 iter.into_iter().for_each(move |(k, v)| {
1950 fn extend_one(&mut self, (k, v): (K, V)) {
1955 #[stable(feature = "extend_ref", since = "1.2.0")]
1956 impl<'a, K: Ord + Copy, V: Copy> Extend<(&'a K, &'a V)> for BTreeMap<K, V> {
1957 fn extend<I: IntoIterator<Item = (&'a K, &'a V)>>(&mut self, iter: I) {
1958 self.extend(iter.into_iter().map(|(&key, &value)| (key, value)));
1962 fn extend_one(&mut self, (&k, &v): (&'a K, &'a V)) {
1967 #[stable(feature = "rust1", since = "1.0.0")]
1968 impl<K: Hash, V: Hash> Hash for BTreeMap<K, V> {
1969 fn hash<H: Hasher>(&self, state: &mut H) {
1976 #[stable(feature = "rust1", since = "1.0.0")]
1977 impl<K: Ord, V> Default for BTreeMap<K, V> {
1978 /// Creates an empty `BTreeMap<K, V>`.
1979 fn default() -> BTreeMap<K, V> {
1984 #[stable(feature = "rust1", since = "1.0.0")]
1985 impl<K: PartialEq, V: PartialEq> PartialEq for BTreeMap<K, V> {
1986 fn eq(&self, other: &BTreeMap<K, V>) -> bool {
1987 self.len() == other.len() && self.iter().zip(other).all(|(a, b)| a == b)
1991 #[stable(feature = "rust1", since = "1.0.0")]
1992 impl<K: Eq, V: Eq> Eq for BTreeMap<K, V> {}
1994 #[stable(feature = "rust1", since = "1.0.0")]
1995 impl<K: PartialOrd, V: PartialOrd> PartialOrd for BTreeMap<K, V> {
1997 fn partial_cmp(&self, other: &BTreeMap<K, V>) -> Option<Ordering> {
1998 self.iter().partial_cmp(other.iter())
2002 #[stable(feature = "rust1", since = "1.0.0")]
2003 impl<K: Ord, V: Ord> Ord for BTreeMap<K, V> {
2005 fn cmp(&self, other: &BTreeMap<K, V>) -> Ordering {
2006 self.iter().cmp(other.iter())
2010 #[stable(feature = "rust1", since = "1.0.0")]
2011 impl<K: Debug, V: Debug> Debug for BTreeMap<K, V> {
2012 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2013 f.debug_map().entries(self.iter()).finish()
2017 #[stable(feature = "rust1", since = "1.0.0")]
2018 impl<K: Ord, Q: ?Sized, V> Index<&Q> for BTreeMap<K, V>
2025 /// Returns a reference to the value corresponding to the supplied key.
2029 /// Panics if the key is not present in the `BTreeMap`.
2031 fn index(&self, key: &Q) -> &V {
2032 self.get(key).expect("no entry found for key")
2036 /// Finds the leaf edges delimiting a specified range in or underneath a node.
2037 fn range_search<BorrowType, K, V, Q: ?Sized, R: RangeBounds<Q>>(
2038 root: NodeRef<BorrowType, K, V, marker::LeafOrInternal>,
2041 Handle<NodeRef<BorrowType, K, V, marker::Leaf>, marker::Edge>,
2042 Handle<NodeRef<BorrowType, K, V, marker::Leaf>, marker::Edge>,
2048 match (range.start_bound(), range.end_bound()) {
2049 (Excluded(s), Excluded(e)) if s == e => {
2050 panic!("range start and end are equal and excluded in BTreeMap")
2052 (Included(s) | Excluded(s), Included(e) | Excluded(e)) if s > e => {
2053 panic!("range start is greater than range end in BTreeMap")
2058 // We duplicate the root NodeRef here -- we will never access it in a way
2059 // that overlaps references obtained from the root.
2060 let mut min_node = unsafe { ptr::read(&root) };
2061 let mut max_node = root;
2062 let mut min_found = false;
2063 let mut max_found = false;
2066 let front = match (min_found, range.start_bound()) {
2067 (false, Included(key)) => match search::search_node(min_node, key) {
2072 GoDown(edge) => edge,
2074 (false, Excluded(key)) => match search::search_node(min_node, key) {
2079 GoDown(edge) => edge,
2081 (true, Included(_)) => min_node.last_edge(),
2082 (true, Excluded(_)) => min_node.first_edge(),
2083 (_, Unbounded) => min_node.first_edge(),
2086 let back = match (max_found, range.end_bound()) {
2087 (false, Included(key)) => match search::search_node(max_node, key) {
2092 GoDown(edge) => edge,
2094 (false, Excluded(key)) => match search::search_node(max_node, key) {
2099 GoDown(edge) => edge,
2101 (true, Included(_)) => max_node.first_edge(),
2102 (true, Excluded(_)) => max_node.last_edge(),
2103 (_, Unbounded) => max_node.last_edge(),
2106 if front.partial_cmp(&back) == Some(Ordering::Greater) {
2107 panic!("Ord is ill-defined in BTreeMap range");
2109 match (front.force(), back.force()) {
2110 (Leaf(f), Leaf(b)) => {
2113 (Internal(min_int), Internal(max_int)) => {
2114 min_node = min_int.descend();
2115 max_node = max_int.descend();
2117 _ => unreachable!("BTreeMap has different depths"),
2122 /// Equivalent to `range_search(k, v, ..)` without the `Ord` bound.
2123 fn full_range_search<BorrowType, K, V>(
2124 root: NodeRef<BorrowType, K, V, marker::LeafOrInternal>,
2126 Handle<NodeRef<BorrowType, K, V, marker::Leaf>, marker::Edge>,
2127 Handle<NodeRef<BorrowType, K, V, marker::Leaf>, marker::Edge>,
2129 // We duplicate the root NodeRef here -- we will never access it in a way
2130 // that overlaps references obtained from the root.
2131 let mut min_node = unsafe { ptr::read(&root) };
2132 let mut max_node = root;
2134 let front = min_node.first_edge();
2135 let back = max_node.last_edge();
2136 match (front.force(), back.force()) {
2137 (Leaf(f), Leaf(b)) => {
2140 (Internal(min_int), Internal(max_int)) => {
2141 min_node = min_int.descend();
2142 max_node = max_int.descend();
2144 _ => unreachable!("BTreeMap has different depths"),
2149 impl<K, V> BTreeMap<K, V> {
2150 /// Gets an iterator over the entries of the map, sorted by key.
2157 /// use std::collections::BTreeMap;
2159 /// let mut map = BTreeMap::new();
2160 /// map.insert(3, "c");
2161 /// map.insert(2, "b");
2162 /// map.insert(1, "a");
2164 /// for (key, value) in map.iter() {
2165 /// println!("{}: {}", key, value);
2168 /// let (first_key, first_value) = map.iter().next().unwrap();
2169 /// assert_eq!((*first_key, *first_value), (1, "a"));
2171 #[stable(feature = "rust1", since = "1.0.0")]
2172 pub fn iter(&self) -> Iter<'_, K, V> {
2173 if let Some(root) = &self.root {
2174 let (f, b) = full_range_search(root.as_ref());
2176 Iter { range: Range { front: Some(f), back: Some(b) }, length: self.length }
2178 Iter { range: Range { front: None, back: None }, length: 0 }
2182 /// Gets a mutable iterator over the entries of the map, sorted by key.
2189 /// use std::collections::BTreeMap;
2191 /// let mut map = BTreeMap::new();
2192 /// map.insert("a", 1);
2193 /// map.insert("b", 2);
2194 /// map.insert("c", 3);
2196 /// // add 10 to the value if the key isn't "a"
2197 /// for (key, value) in map.iter_mut() {
2198 /// if key != &"a" {
2203 #[stable(feature = "rust1", since = "1.0.0")]
2204 pub fn iter_mut(&mut self) -> IterMut<'_, K, V> {
2205 if let Some(root) = &mut self.root {
2206 let (f, b) = full_range_search(root.as_mut());
2209 range: RangeMut { front: Some(f), back: Some(b), _marker: PhantomData },
2210 length: self.length,
2213 IterMut { range: RangeMut { front: None, back: None, _marker: PhantomData }, length: 0 }
2217 /// Gets an iterator over the keys of the map, in sorted order.
2224 /// use std::collections::BTreeMap;
2226 /// let mut a = BTreeMap::new();
2227 /// a.insert(2, "b");
2228 /// a.insert(1, "a");
2230 /// let keys: Vec<_> = a.keys().cloned().collect();
2231 /// assert_eq!(keys, [1, 2]);
2233 #[stable(feature = "rust1", since = "1.0.0")]
2234 pub fn keys(&self) -> Keys<'_, K, V> {
2235 Keys { inner: self.iter() }
2238 /// Gets an iterator over the values of the map, in order by key.
2245 /// use std::collections::BTreeMap;
2247 /// let mut a = BTreeMap::new();
2248 /// a.insert(1, "hello");
2249 /// a.insert(2, "goodbye");
2251 /// let values: Vec<&str> = a.values().cloned().collect();
2252 /// assert_eq!(values, ["hello", "goodbye"]);
2254 #[stable(feature = "rust1", since = "1.0.0")]
2255 pub fn values(&self) -> Values<'_, K, V> {
2256 Values { inner: self.iter() }
2259 /// Gets a mutable iterator over the values of the map, in order by key.
2266 /// use std::collections::BTreeMap;
2268 /// let mut a = BTreeMap::new();
2269 /// a.insert(1, String::from("hello"));
2270 /// a.insert(2, String::from("goodbye"));
2272 /// for value in a.values_mut() {
2273 /// value.push_str("!");
2276 /// let values: Vec<String> = a.values().cloned().collect();
2277 /// assert_eq!(values, [String::from("hello!"),
2278 /// String::from("goodbye!")]);
2280 #[stable(feature = "map_values_mut", since = "1.10.0")]
2281 pub fn values_mut(&mut self) -> ValuesMut<'_, K, V> {
2282 ValuesMut { inner: self.iter_mut() }
2285 /// Returns the number of elements in the map.
2292 /// use std::collections::BTreeMap;
2294 /// let mut a = BTreeMap::new();
2295 /// assert_eq!(a.len(), 0);
2296 /// a.insert(1, "a");
2297 /// assert_eq!(a.len(), 1);
2299 #[stable(feature = "rust1", since = "1.0.0")]
2300 pub fn len(&self) -> usize {
2304 /// Returns `true` if the map contains no elements.
2311 /// use std::collections::BTreeMap;
2313 /// let mut a = BTreeMap::new();
2314 /// assert!(a.is_empty());
2315 /// a.insert(1, "a");
2316 /// assert!(!a.is_empty());
2318 #[stable(feature = "rust1", since = "1.0.0")]
2319 pub fn is_empty(&self) -> bool {
2323 /// If the root node is the empty (non-allocated) root node, allocate our
2325 fn ensure_root_is_owned(&mut self) -> &mut node::Root<K, V> {
2326 self.root.get_or_insert_with(node::Root::new_leaf)
2330 impl<'a, K: Ord, V> Entry<'a, K, V> {
2331 /// Ensures a value is in the entry by inserting the default if empty, and returns
2332 /// a mutable reference to the value in the entry.
2337 /// use std::collections::BTreeMap;
2339 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2340 /// map.entry("poneyland").or_insert(12);
2342 /// assert_eq!(map["poneyland"], 12);
2344 #[stable(feature = "rust1", since = "1.0.0")]
2345 pub fn or_insert(self, default: V) -> &'a mut V {
2347 Occupied(entry) => entry.into_mut(),
2348 Vacant(entry) => entry.insert(default),
2352 /// Ensures a value is in the entry by inserting the result of the default function if empty,
2353 /// and returns a mutable reference to the value in the entry.
2358 /// use std::collections::BTreeMap;
2360 /// let mut map: BTreeMap<&str, String> = BTreeMap::new();
2361 /// let s = "hoho".to_string();
2363 /// map.entry("poneyland").or_insert_with(|| s);
2365 /// assert_eq!(map["poneyland"], "hoho".to_string());
2367 #[stable(feature = "rust1", since = "1.0.0")]
2368 pub fn or_insert_with<F: FnOnce() -> V>(self, default: F) -> &'a mut V {
2370 Occupied(entry) => entry.into_mut(),
2371 Vacant(entry) => entry.insert(default()),
2375 #[unstable(feature = "or_insert_with_key", issue = "71024")]
2376 /// Ensures a value is in the entry by inserting, if empty, the result of the default function,
2377 /// which takes the key as its argument, and returns a mutable reference to the value in the
2383 /// #![feature(or_insert_with_key)]
2384 /// use std::collections::BTreeMap;
2386 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2388 /// map.entry("poneyland").or_insert_with_key(|key| key.chars().count());
2390 /// assert_eq!(map["poneyland"], 9);
2393 pub fn or_insert_with_key<F: FnOnce(&K) -> V>(self, default: F) -> &'a mut V {
2395 Occupied(entry) => entry.into_mut(),
2397 let value = default(entry.key());
2403 /// Returns a reference to this entry's key.
2408 /// use std::collections::BTreeMap;
2410 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2411 /// assert_eq!(map.entry("poneyland").key(), &"poneyland");
2413 #[stable(feature = "map_entry_keys", since = "1.10.0")]
2414 pub fn key(&self) -> &K {
2416 Occupied(ref entry) => entry.key(),
2417 Vacant(ref entry) => entry.key(),
2421 /// Provides in-place mutable access to an occupied entry before any
2422 /// potential inserts into the map.
2427 /// use std::collections::BTreeMap;
2429 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2431 /// map.entry("poneyland")
2432 /// .and_modify(|e| { *e += 1 })
2434 /// assert_eq!(map["poneyland"], 42);
2436 /// map.entry("poneyland")
2437 /// .and_modify(|e| { *e += 1 })
2439 /// assert_eq!(map["poneyland"], 43);
2441 #[stable(feature = "entry_and_modify", since = "1.26.0")]
2442 pub fn and_modify<F>(self, f: F) -> Self
2447 Occupied(mut entry) => {
2451 Vacant(entry) => Vacant(entry),
2456 impl<'a, K: Ord, V: Default> Entry<'a, K, V> {
2457 #[stable(feature = "entry_or_default", since = "1.28.0")]
2458 /// Ensures a value is in the entry by inserting the default value if empty,
2459 /// and returns a mutable reference to the value in the entry.
2464 /// use std::collections::BTreeMap;
2466 /// let mut map: BTreeMap<&str, Option<usize>> = BTreeMap::new();
2467 /// map.entry("poneyland").or_default();
2469 /// assert_eq!(map["poneyland"], None);
2471 pub fn or_default(self) -> &'a mut V {
2473 Occupied(entry) => entry.into_mut(),
2474 Vacant(entry) => entry.insert(Default::default()),
2479 impl<'a, K: Ord, V> VacantEntry<'a, K, V> {
2480 /// Gets a reference to the key that would be used when inserting a value
2481 /// through the VacantEntry.
2486 /// use std::collections::BTreeMap;
2488 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2489 /// assert_eq!(map.entry("poneyland").key(), &"poneyland");
2491 #[stable(feature = "map_entry_keys", since = "1.10.0")]
2492 pub fn key(&self) -> &K {
2496 /// Take ownership of the key.
2501 /// use std::collections::BTreeMap;
2502 /// use std::collections::btree_map::Entry;
2504 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2506 /// if let Entry::Vacant(v) = map.entry("poneyland") {
2510 #[stable(feature = "map_entry_recover_keys2", since = "1.12.0")]
2511 pub fn into_key(self) -> K {
2515 /// Sets the value of the entry with the `VacantEntry`'s key,
2516 /// and returns a mutable reference to it.
2521 /// use std::collections::BTreeMap;
2522 /// use std::collections::btree_map::Entry;
2524 /// let mut map: BTreeMap<&str, u32> = BTreeMap::new();
2526 /// if let Entry::Vacant(o) = map.entry("poneyland") {
2529 /// assert_eq!(map["poneyland"], 37);
2531 #[stable(feature = "rust1", since = "1.0.0")]
2532 pub fn insert(self, value: V) -> &'a mut V {
2541 let mut cur_parent = match self.handle.insert(self.key, value) {
2542 (Fit(handle), _) => return handle.into_kv_mut().1,
2543 (Split(left, k, v, right), ptr) => {
2548 left.ascend().map_err(|n| n.into_root_mut())
2554 Ok(parent) => match parent.insert(ins_k, ins_v, ins_edge) {
2555 Fit(_) => return unsafe { &mut *out_ptr },
2556 Split(left, k, v, right) => {
2560 cur_parent = left.ascend().map_err(|n| n.into_root_mut());
2564 root.push_level().push(ins_k, ins_v, ins_edge);
2565 return unsafe { &mut *out_ptr };
2572 impl<'a, K: Ord, V> OccupiedEntry<'a, K, V> {
2573 /// Gets a reference to the key in the entry.
2578 /// use std::collections::BTreeMap;
2580 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2581 /// map.entry("poneyland").or_insert(12);
2582 /// assert_eq!(map.entry("poneyland").key(), &"poneyland");
2584 #[stable(feature = "map_entry_keys", since = "1.10.0")]
2585 pub fn key(&self) -> &K {
2586 self.handle.reborrow().into_kv().0
2589 /// Take ownership of the key and value from the map.
2594 /// use std::collections::BTreeMap;
2595 /// use std::collections::btree_map::Entry;
2597 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2598 /// map.entry("poneyland").or_insert(12);
2600 /// if let Entry::Occupied(o) = map.entry("poneyland") {
2601 /// // We delete the entry from the map.
2602 /// o.remove_entry();
2605 /// // If now try to get the value, it will panic:
2606 /// // println!("{}", map["poneyland"]);
2608 #[stable(feature = "map_entry_recover_keys2", since = "1.12.0")]
2609 pub fn remove_entry(self) -> (K, V) {
2613 /// Gets a reference to the value in the entry.
2618 /// use std::collections::BTreeMap;
2619 /// use std::collections::btree_map::Entry;
2621 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2622 /// map.entry("poneyland").or_insert(12);
2624 /// if let Entry::Occupied(o) = map.entry("poneyland") {
2625 /// assert_eq!(o.get(), &12);
2628 #[stable(feature = "rust1", since = "1.0.0")]
2629 pub fn get(&self) -> &V {
2630 self.handle.reborrow().into_kv().1
2633 /// Gets a mutable reference to the value in the entry.
2635 /// If you need a reference to the `OccupiedEntry` that may outlive the
2636 /// destruction of the `Entry` value, see [`into_mut`].
2638 /// [`into_mut`]: #method.into_mut
2643 /// use std::collections::BTreeMap;
2644 /// use std::collections::btree_map::Entry;
2646 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2647 /// map.entry("poneyland").or_insert(12);
2649 /// assert_eq!(map["poneyland"], 12);
2650 /// if let Entry::Occupied(mut o) = map.entry("poneyland") {
2651 /// *o.get_mut() += 10;
2652 /// assert_eq!(*o.get(), 22);
2654 /// // We can use the same Entry multiple times.
2655 /// *o.get_mut() += 2;
2657 /// assert_eq!(map["poneyland"], 24);
2659 #[stable(feature = "rust1", since = "1.0.0")]
2660 pub fn get_mut(&mut self) -> &mut V {
2661 self.handle.kv_mut().1
2664 /// Converts the entry into a mutable reference to its value.
2666 /// If you need multiple references to the `OccupiedEntry`, see [`get_mut`].
2668 /// [`get_mut`]: #method.get_mut
2673 /// use std::collections::BTreeMap;
2674 /// use std::collections::btree_map::Entry;
2676 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2677 /// map.entry("poneyland").or_insert(12);
2679 /// assert_eq!(map["poneyland"], 12);
2680 /// if let Entry::Occupied(o) = map.entry("poneyland") {
2681 /// *o.into_mut() += 10;
2683 /// assert_eq!(map["poneyland"], 22);
2685 #[stable(feature = "rust1", since = "1.0.0")]
2686 pub fn into_mut(self) -> &'a mut V {
2687 self.handle.into_kv_mut().1
2690 /// Sets the value of the entry with the `OccupiedEntry`'s key,
2691 /// and returns the entry's old value.
2696 /// use std::collections::BTreeMap;
2697 /// use std::collections::btree_map::Entry;
2699 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2700 /// map.entry("poneyland").or_insert(12);
2702 /// if let Entry::Occupied(mut o) = map.entry("poneyland") {
2703 /// assert_eq!(o.insert(15), 12);
2705 /// assert_eq!(map["poneyland"], 15);
2707 #[stable(feature = "rust1", since = "1.0.0")]
2708 pub fn insert(&mut self, value: V) -> V {
2709 mem::replace(self.get_mut(), value)
2712 /// Takes the value of the entry out of the map, and returns it.
2717 /// use std::collections::BTreeMap;
2718 /// use std::collections::btree_map::Entry;
2720 /// let mut map: BTreeMap<&str, usize> = BTreeMap::new();
2721 /// map.entry("poneyland").or_insert(12);
2723 /// if let Entry::Occupied(o) = map.entry("poneyland") {
2724 /// assert_eq!(o.remove(), 12);
2726 /// // If we try to get "poneyland"'s value, it'll panic:
2727 /// // println!("{}", map["poneyland"]);
2729 #[stable(feature = "rust1", since = "1.0.0")]
2730 pub fn remove(self) -> V {
2734 fn remove_kv(self) -> (K, V) {
2737 let (old_key, old_val, _) = self.handle.remove_kv_tracking();
2742 impl<'a, K: 'a, V: 'a> Handle<NodeRef<marker::Mut<'a>, K, V, marker::LeafOrInternal>, marker::KV> {
2743 /// Removes a key/value-pair from the map, and returns that pair, as well as
2744 /// the leaf edge corresponding to that former pair.
2745 fn remove_kv_tracking(
2747 ) -> (K, V, Handle<NodeRef<marker::Mut<'a>, K, V, marker::Leaf>, marker::Edge>) {
2748 let (mut pos, old_key, old_val, was_internal) = match self.force() {
2750 let (hole, old_key, old_val) = leaf.remove();
2751 (hole, old_key, old_val, false)
2753 Internal(mut internal) => {
2754 // Replace the location freed in the internal node with the next KV,
2755 // and remove that next KV from its leaf.
2757 let key_loc = internal.kv_mut().0 as *mut K;
2758 let val_loc = internal.kv_mut().1 as *mut V;
2760 // Deleting from the left side is typically faster since we can
2761 // just pop an element from the end of the KV array without
2762 // needing to shift the other values.
2763 let to_remove = internal.left_edge().descend().last_leaf_edge().left_kv().ok();
2764 let to_remove = unsafe { unwrap_unchecked(to_remove) };
2766 let (hole, key, val) = to_remove.remove();
2768 let old_key = unsafe { mem::replace(&mut *key_loc, key) };
2769 let old_val = unsafe { mem::replace(&mut *val_loc, val) };
2771 (hole, old_key, old_val, true)
2776 let mut cur_node = unsafe { ptr::read(&pos).into_node().forget_type() };
2777 let mut at_leaf = true;
2778 while cur_node.len() < node::MIN_LEN {
2779 match handle_underfull_node(cur_node) {
2781 Merged(edge, merged_with_left, offset) => {
2782 // If we merged with our right sibling then our tracked
2783 // position has not changed. However if we merged with our
2784 // left sibling then our tracked position is now dangling.
2785 if at_leaf && merged_with_left {
2786 let idx = pos.idx() + offset;
2787 let node = match unsafe { ptr::read(&edge).descend().force() } {
2789 Internal(_) => unreachable!(),
2791 pos = unsafe { Handle::new_edge(node, idx) };
2794 let parent = edge.into_node();
2795 if parent.len() == 0 {
2796 // We must be at the root
2797 parent.into_root_mut().pop_level();
2800 cur_node = parent.forget_type();
2804 Stole(stole_from_left) => {
2805 // Adjust the tracked position if we stole from a left sibling
2806 if stole_from_left && at_leaf {
2807 // SAFETY: This is safe since we just added an element to our node.
2809 pos.next_unchecked();
2817 // If we deleted from an internal node then we need to compensate for
2818 // the earlier swap and adjust the tracked position to point to the
2821 pos = unsafe { unwrap_unchecked(pos.next_kv().ok()).next_leaf_edge() };
2824 (old_key, old_val, pos)
2828 enum UnderflowResult<'a, K, V> {
2830 Merged(Handle<NodeRef<marker::Mut<'a>, K, V, marker::Internal>, marker::Edge>, bool, usize),
2834 fn handle_underfull_node<K, V>(
2835 node: NodeRef<marker::Mut<'_>, K, V, marker::LeafOrInternal>,
2836 ) -> UnderflowResult<'_, K, V> {
2837 let parent = match node.ascend() {
2838 Ok(parent) => parent,
2839 Err(_) => return AtRoot,
2842 let (is_left, mut handle) = match parent.left_kv() {
2843 Ok(left) => (true, left),
2845 let right = unsafe { unwrap_unchecked(parent.right_kv().ok()) };
2850 if handle.can_merge() {
2851 let offset = if is_left { handle.reborrow().left_edge().descend().len() + 1 } else { 0 };
2852 Merged(handle.merge(), is_left, offset)
2855 handle.steal_left();
2857 handle.steal_right();
2863 impl<K: Ord, V, I: Iterator<Item = (K, V)>> Iterator for MergeIter<K, V, I> {
2866 fn next(&mut self) -> Option<(K, V)> {
2867 let res = match (self.left.peek(), self.right.peek()) {
2868 (Some(&(ref left_key, _)), Some(&(ref right_key, _))) => left_key.cmp(right_key),
2869 (Some(_), None) => Ordering::Less,
2870 (None, Some(_)) => Ordering::Greater,
2871 (None, None) => return None,
2874 // Check which elements comes first and only advance the corresponding iterator.
2875 // If two keys are equal, take the value from `right`.
2877 Ordering::Less => self.left.next(),
2878 Ordering::Greater => self.right.next(),
2879 Ordering::Equal => {