pub struct MutableBTreeMapLockMut<'a, K, V>where
K: 'a,
V: 'a,{ /* private fields */ }
Implementations§
source§impl<'a, K, V> MutableBTreeMapLockMut<'a, K, V>where
K: Ord + Clone,
impl<'a, K, V> MutableBTreeMapLockMut<'a, K, V>where K: Ord + Clone,
source§impl<'a, K, V> MutableBTreeMapLockMut<'a, K, V>where
K: Ord + Clone,
V: Clone,
impl<'a, K, V> MutableBTreeMapLockMut<'a, K, V>where K: Ord + Clone, V: Clone,
pub fn replace_cloned(&mut self, values: BTreeMap<K, V>)
pub fn insert_cloned(&mut self, key: K, value: V) -> Option<V>
Methods from Deref<Target = BTreeMap<K, V>>§
1.0.0 · sourcepub fn get<Q>(&self, key: &Q) -> Option<&V>where
K: Borrow<Q> + Ord,
Q: Ord + ?Sized,
pub fn get<Q>(&self, key: &Q) -> Option<&V>where K: Borrow<Q> + Ord, Q: Ord + ?Sized,
Returns a reference to the value corresponding to the key.
The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
Examples
use std::collections::BTreeMap;
let mut map = BTreeMap::new();
map.insert(1, "a");
assert_eq!(map.get(&1), Some(&"a"));
assert_eq!(map.get(&2), None);
1.40.0 · sourcepub fn get_key_value<Q>(&self, k: &Q) -> Option<(&K, &V)>where
K: Borrow<Q> + Ord,
Q: Ord + ?Sized,
pub fn get_key_value<Q>(&self, k: &Q) -> Option<(&K, &V)>where K: Borrow<Q> + Ord, Q: Ord + ?Sized,
Returns the key-value pair corresponding to the supplied key.
The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
Examples
use std::collections::BTreeMap;
let mut map = BTreeMap::new();
map.insert(1, "a");
assert_eq!(map.get_key_value(&1), Some((&1, &"a")));
assert_eq!(map.get_key_value(&2), None);
1.66.0 · sourcepub fn first_key_value(&self) -> Option<(&K, &V)>where
K: Ord,
pub fn first_key_value(&self) -> Option<(&K, &V)>where K: Ord,
Returns the first key-value pair in the map. The key in this pair is the minimum key in the map.
Examples
use std::collections::BTreeMap;
let mut map = BTreeMap::new();
assert_eq!(map.first_key_value(), None);
map.insert(1, "b");
map.insert(2, "a");
assert_eq!(map.first_key_value(), Some((&1, &"b")));
1.66.0 · sourcepub fn last_key_value(&self) -> Option<(&K, &V)>where
K: Ord,
pub fn last_key_value(&self) -> Option<(&K, &V)>where K: Ord,
Returns the last key-value pair in the map. The key in this pair is the maximum key in the map.
Examples
use std::collections::BTreeMap;
let mut map = BTreeMap::new();
map.insert(1, "b");
map.insert(2, "a");
assert_eq!(map.last_key_value(), Some((&2, &"a")));
1.0.0 · sourcepub fn contains_key<Q>(&self, key: &Q) -> boolwhere
K: Borrow<Q> + Ord,
Q: Ord + ?Sized,
pub fn contains_key<Q>(&self, key: &Q) -> boolwhere K: Borrow<Q> + Ord, Q: Ord + ?Sized,
Returns true
if the map contains a value for the specified key.
The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
Examples
use std::collections::BTreeMap;
let mut map = BTreeMap::new();
map.insert(1, "a");
assert_eq!(map.contains_key(&1), true);
assert_eq!(map.contains_key(&2), false);
1.17.0 · sourcepub fn range<T, R>(&self, range: R) -> Range<'_, K, V>where
T: Ord + ?Sized,
K: Borrow<T> + Ord,
R: RangeBounds<T>,
pub fn range<T, R>(&self, range: R) -> Range<'_, K, V>where T: Ord + ?Sized, K: Borrow<T> + Ord, R: RangeBounds<T>,
Constructs a double-ended iterator over a sub-range of elements in the map.
The simplest way is to use the range syntax min..max
, thus range(min..max)
will
yield elements from min (inclusive) to max (exclusive).
The range may also be entered as (Bound<T>, Bound<T>)
, so for example
range((Excluded(4), Included(10)))
will yield a left-exclusive, right-inclusive
range from 4 to 10.
Panics
Panics if range start > end
.
Panics if range start == end
and both bounds are Excluded
.
Examples
use std::collections::BTreeMap;
use std::ops::Bound::Included;
let mut map = BTreeMap::new();
map.insert(3, "a");
map.insert(5, "b");
map.insert(8, "c");
for (&key, &value) in map.range((Included(&4), Included(&8))) {
println!("{key}: {value}");
}
assert_eq!(Some((&5, &"b")), map.range(4..).next());
1.0.0 · sourcepub fn iter(&self) -> Iter<'_, K, V>
pub fn iter(&self) -> Iter<'_, K, V>
Gets an iterator over the entries of the map, sorted by key.
Examples
use std::collections::BTreeMap;
let mut map = BTreeMap::new();
map.insert(3, "c");
map.insert(2, "b");
map.insert(1, "a");
for (key, value) in map.iter() {
println!("{key}: {value}");
}
let (first_key, first_value) = map.iter().next().unwrap();
assert_eq!((*first_key, *first_value), (1, "a"));
1.0.0 · sourcepub fn keys(&self) -> Keys<'_, K, V>
pub fn keys(&self) -> Keys<'_, K, V>
Gets an iterator over the keys of the map, in sorted order.
Examples
use std::collections::BTreeMap;
let mut a = BTreeMap::new();
a.insert(2, "b");
a.insert(1, "a");
let keys: Vec<_> = a.keys().cloned().collect();
assert_eq!(keys, [1, 2]);
1.0.0 · sourcepub fn values(&self) -> Values<'_, K, V>
pub fn values(&self) -> Values<'_, K, V>
Gets an iterator over the values of the map, in order by key.
Examples
use std::collections::BTreeMap;
let mut a = BTreeMap::new();
a.insert(1, "hello");
a.insert(2, "goodbye");
let values: Vec<&str> = a.values().cloned().collect();
assert_eq!(values, ["hello", "goodbye"]);
1.0.0 · sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the number of elements in the map.
Examples
use std::collections::BTreeMap;
let mut a = BTreeMap::new();
assert_eq!(a.len(), 0);
a.insert(1, "a");
assert_eq!(a.len(), 1);
1.0.0 · sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true
if the map contains no elements.
Examples
use std::collections::BTreeMap;
let mut a = BTreeMap::new();
assert!(a.is_empty());
a.insert(1, "a");
assert!(!a.is_empty());
sourcepub fn lower_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, K, V>where
K: Borrow<Q> + Ord,
Q: Ord,
🔬This is a nightly-only experimental API. (btree_cursors
)
pub fn lower_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, K, V>where K: Borrow<Q> + Ord, Q: Ord,
btree_cursors
)Returns a Cursor
pointing at the first element that is above the
given bound.
If no such element exists then a cursor pointing at the “ghost” non-element is returned.
Passing Bound::Unbounded
will return a cursor pointing at the first
element of the map.
Examples
#![feature(btree_cursors)]
use std::collections::BTreeMap;
use std::ops::Bound;
let mut a = BTreeMap::new();
a.insert(1, "a");
a.insert(2, "b");
a.insert(3, "c");
a.insert(4, "c");
let cursor = a.lower_bound(Bound::Included(&2));
assert_eq!(cursor.key(), Some(&2));
let cursor = a.lower_bound(Bound::Excluded(&2));
assert_eq!(cursor.key(), Some(&3));
sourcepub fn upper_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, K, V>where
K: Borrow<Q> + Ord,
Q: Ord,
🔬This is a nightly-only experimental API. (btree_cursors
)
pub fn upper_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, K, V>where K: Borrow<Q> + Ord, Q: Ord,
btree_cursors
)Returns a Cursor
pointing at the last element that is below the
given bound.
If no such element exists then a cursor pointing at the “ghost” non-element is returned.
Passing Bound::Unbounded
will return a cursor pointing at the last
element of the map.
Examples
#![feature(btree_cursors)]
use std::collections::BTreeMap;
use std::ops::Bound;
let mut a = BTreeMap::new();
a.insert(1, "a");
a.insert(2, "b");
a.insert(3, "c");
a.insert(4, "c");
let cursor = a.upper_bound(Bound::Included(&3));
assert_eq!(cursor.key(), Some(&3));
let cursor = a.upper_bound(Bound::Excluded(&3));
assert_eq!(cursor.key(), Some(&2));
Trait Implementations§
source§impl<'a, K, V> Deref for MutableBTreeMapLockMut<'a, K, V>
impl<'a, K, V> Deref for MutableBTreeMapLockMut<'a, K, V>
source§impl<'a, K, V> Ord for MutableBTreeMapLockMut<'a, K, V>where
K: Ord,
V: Ord,
impl<'a, K, V> Ord for MutableBTreeMapLockMut<'a, K, V>where K: Ord, V: Ord,
source§impl<'a, K, V> PartialEq<BTreeMap<K, V, Global>> for MutableBTreeMapLockMut<'a, K, V>where
K: PartialEq<K>,
V: PartialEq<V>,
impl<'a, K, V> PartialEq<BTreeMap<K, V, Global>> for MutableBTreeMapLockMut<'a, K, V>where K: PartialEq<K>, V: PartialEq<V>,
source§impl<'a, K, V> PartialEq<MutableBTreeMapLockMut<'a, K, V>> for MutableBTreeMapLockMut<'a, K, V>where
K: PartialEq<K>,
V: PartialEq<V>,
impl<'a, K, V> PartialEq<MutableBTreeMapLockMut<'a, K, V>> for MutableBTreeMapLockMut<'a, K, V>where K: PartialEq<K>, V: PartialEq<V>,
source§fn eq(&self, other: &MutableBTreeMapLockMut<'a, K, V>) -> bool
fn eq(&self, other: &MutableBTreeMapLockMut<'a, K, V>) -> bool
self
and other
values to be equal, and is used
by ==
.source§fn ne(&self, other: &MutableBTreeMapLockMut<'a, K, V>) -> bool
fn ne(&self, other: &MutableBTreeMapLockMut<'a, K, V>) -> bool
!=
. The default implementation is almost always
sufficient, and should not be overridden without very good reason.source§impl<'a, K, V> PartialOrd<BTreeMap<K, V, Global>> for MutableBTreeMapLockMut<'a, K, V>where
K: PartialOrd<K>,
V: PartialOrd<V>,
impl<'a, K, V> PartialOrd<BTreeMap<K, V, Global>> for MutableBTreeMapLockMut<'a, K, V>where K: PartialOrd<K>, V: PartialOrd<V>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<'a, K, V> PartialOrd<MutableBTreeMapLockMut<'a, K, V>> for MutableBTreeMapLockMut<'a, K, V>where
K: PartialOrd<K>,
V: PartialOrd<V>,
impl<'a, K, V> PartialOrd<MutableBTreeMapLockMut<'a, K, V>> for MutableBTreeMapLockMut<'a, K, V>where K: PartialOrd<K>, V: PartialOrd<V>,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more