pub struct BTreeSet<T> { /* fields omitted */ }
A set based on a B-Tree.
See BTreeMap
's documentation for a detailed discussion of this collection's performance benefits and drawbacks.
It is a logic error for an item to be modified in such a way that the item's ordering relative to any other item, as determined by the Ord
trait, changes while it is in the set. This is normally only possible through Cell
, RefCell
, global state, I/O, or unsafe code.
use std::collections::BTreeSet; // Type inference lets us omit an explicit type signature (which // would be `BTreeSet<&str>` in this example). let mut books = BTreeSet::new(); // Add some books. books.insert("A Dance With Dragons"); books.insert("To Kill a Mockingbird"); books.insert("The Odyssey"); books.insert("The Great Gatsby"); // Check for a specific one. if !books.contains("The Winds of Winter") { println!("We have {} books, but The Winds of Winter ain't one.", books.len()); } // Remove a book. books.remove("The Odyssey"); // Iterate over everything. for book in &books { println!("{}", book); }
impl<T> BTreeSet<T> where
T: Ord,
[src]
pub fn new() -> BTreeSet<T>
[src]
Makes a new BTreeSet
with a reasonable choice of B.
pub fn range<K, R>(&self, range: R) -> Range<'_, T>ⓘ where
K: Ord + ?Sized,
R: RangeBounds<K>,
T: Borrow<K>,
[src]1.17.0
Constructs a double-ended iterator over a sub-range of elements in the set. 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.
pub fn difference(&'a self, other: &'a BTreeSet<T>) -> Difference<'a, T>ⓘ
[src]
Visits the values representing the difference, i.e., the values that are in self
but not in other
, in ascending order.
pub fn symmetric_difference(
&'a self,
other: &'a BTreeSet<T>
) -> SymmetricDifference<'a, T>ⓘ
[src]
Visits the values representing the symmetric difference, i.e., the values that are in self
or in other
but not in both, in ascending order.
pub fn intersection(&'a self, other: &'a BTreeSet<T>) -> Intersection<'a, T>ⓘ
[src]
Visits the values representing the intersection, i.e., the values that are both in self
and other
, in ascending order.
pub fn union(&'a self, other: &'a BTreeSet<T>) -> Union<'a, T>ⓘ
[src]
Visits the values representing the union, i.e., all the values in self
or other
, without duplicates, in ascending order.
pub fn clear(&mut self)
[src]
Clears the set, removing all values.
pub fn contains<Q>(&self, value: &Q) -> bool where
Q: Ord + ?Sized,
T: Borrow<Q>,
[src]
Returns true
if the set contains a value.
The value may be any borrowed form of the set's value type, but the ordering on the borrowed form must match the ordering on the value type.
pub fn get<Q>(&self, value: &Q) -> Option<&T> where
Q: Ord + ?Sized,
T: Borrow<Q>,
[src]1.9.0
Returns a reference to the value in the set, if any, that is equal to the given value.
The value may be any borrowed form of the set's value type, but the ordering on the borrowed form must match the ordering on the value type.
pub fn is_disjoint(&self, other: &BTreeSet<T>) -> bool
[src]
Returns true
if self
has no elements in common with other
. This is equivalent to checking for an empty intersection.
pub fn is_subset(&self, other: &BTreeSet<T>) -> bool
[src]
Returns true
if the set is a subset of another, i.e., other
contains at least all the values in self
.
pub fn is_superset(&self, other: &BTreeSet<T>) -> bool
[src]
Returns true
if the set is a superset of another, i.e., self
contains at least all the values in other
.
pub fn first(&self) -> Option<&T>
[src]
Returns a reference to the first value in the set, if any. This value is always the minimum of all values in the set.
Basic usage:
pub fn last(&self) -> Option<&T>
[src]
Returns a reference to the last value in the set, if any. This value is always the maximum of all values in the set.
Basic usage:
pub fn pop_first(&mut self) -> Option<T>
[src]
Removes the first value from the set and returns it, if any. The first value is always the minimum value in the set.
pub fn pop_last(&mut self) -> Option<T>
[src]
Removes the last value from the set and returns it, if any. The last value is always the maximum value in the set.
pub fn insert(&mut self, value: T) -> bool
[src]
Adds a value to the set.
If the set did not have this value present, true
is returned.
If the set did have this value present, false
is returned, and the entry is not updated. See the module-level documentation for more.
pub fn replace(&mut self, value: T) -> Option<T>
[src]1.9.0
Adds a value to the set, replacing the existing value, if any, that is equal to the given one. Returns the replaced value.
pub fn remove<Q>(&mut self, value: &Q) -> bool where
Q: Ord + ?Sized,
T: Borrow<Q>,
[src]
Removes a value from the set. Returns whether the value was present in the set.
The value may be any borrowed form of the set's value type, but the ordering on the borrowed form must match the ordering on the value type.
pub fn take<Q>(&mut self, value: &Q) -> Option<T> where
Q: Ord + ?Sized,
T: Borrow<Q>,
[src]1.9.0
Removes and returns the value in the set, if any, that is equal to the given one.
The value may be any borrowed form of the set's value type, but the ordering on the borrowed form must match the ordering on the value type.
pub fn append(&mut self, other: &mut BTreeSet<T>)
[src]1.11.0
Moves all elements from other
into Self
, leaving other
empty.
use std::collections::BTreeSet; let mut a = BTreeSet::new(); a.insert(1); a.insert(2); a.insert(3); let mut b = BTreeSet::new(); b.insert(3); b.insert(4); b.insert(5); a.append(&mut b); assert_eq!(a.len(), 5); assert_eq!(b.len(), 0); assert!(a.contains(&1)); assert!(a.contains(&2)); assert!(a.contains(&3)); assert!(a.contains(&4)); assert!(a.contains(&5));
pub fn split_off<Q>(&mut self, key: &Q) -> BTreeSet<T> where
Q: Ord + ?Sized,
T: Borrow<Q>,
[src]1.11.0
Splits the collection into two at the given key. Returns everything after the given key, including the key.
Basic usage:
use std::collections::BTreeSet; let mut a = BTreeSet::new(); a.insert(1); a.insert(2); a.insert(3); a.insert(17); a.insert(41); let b = a.split_off(&3); assert_eq!(a.len(), 2); assert_eq!(b.len(), 3); assert!(a.contains(&1)); assert!(a.contains(&2)); assert!(b.contains(&3)); assert!(b.contains(&17)); assert!(b.contains(&41));
pub fn drain_filter<'a, F>(&'a mut self, pred: F) -> DrainFilter<'a, T, F>ⓘ where
F: 'a + FnMut(&T) -> bool,
[src]
Creates an iterator which uses a closure to determine if a value should be removed.
If the closure returns true, then the value is removed and yielded. If the closure returns false, the value will remain in the list and will not be yielded by the iterator.
If the iterator is only partially consumed or not consumed at all, each of the remaining values will still be subjected to the closure and removed and dropped if it returns true.
It is unspecified how many more values will be subjected to the closure if a panic occurs in the closure, or if a panic occurs while dropping a value, or if the DrainFilter
itself is leaked.
Splitting a set into even and odd values, reusing the original set:
#![feature(btree_drain_filter)] use std::collections::BTreeSet; let mut set: BTreeSet<i32> = (0..8).collect(); let evens: BTreeSet<_> = set.drain_filter(|v| v % 2 == 0).collect(); let odds = set; assert_eq!(evens.into_iter().collect::<Vec<_>>(), vec![0, 2, 4, 6]); assert_eq!(odds.into_iter().collect::<Vec<_>>(), vec![1, 3, 5, 7]);
impl<T> BTreeSet<T>
[src]
pub fn iter(&self) -> Iter<'_, T>ⓘ
[src]
Gets an iterator that visits the values in the BTreeSet
in ascending order.
use std::collections::BTreeSet; let set: BTreeSet<usize> = [1, 2, 3].iter().cloned().collect(); let mut set_iter = set.iter(); assert_eq!(set_iter.next(), Some(&1)); assert_eq!(set_iter.next(), Some(&2)); assert_eq!(set_iter.next(), Some(&3)); assert_eq!(set_iter.next(), None);
Values returned by the iterator are returned in ascending order:
pub fn len(&self) -> usize
[src]
Returns the number of elements in the set.
pub fn is_empty(&self) -> bool
[src]
Returns true
if the set contains no elements.
impl<'_, '_, T> BitAnd<&'_ BTreeSet<T>> for &'_ BTreeSet<T> where
T: Clone + Ord,
[src]
type Output = BTreeSet<T>
The resulting type after applying the &
operator.
fn bitand(self, rhs: &BTreeSet<T>) -> BTreeSet<T>
[src]
Returns the intersection of self
and rhs
as a new BTreeSet<T>
.
impl<'_, '_, T> BitOr<&'_ BTreeSet<T>> for &'_ BTreeSet<T> where
T: Clone + Ord,
[src]
type Output = BTreeSet<T>
The resulting type after applying the |
operator.
fn bitor(self, rhs: &BTreeSet<T>) -> BTreeSet<T>
[src]
Returns the union of self
and rhs
as a new BTreeSet<T>
.
impl<'_, '_, T> BitXor<&'_ BTreeSet<T>> for &'_ BTreeSet<T> where
T: Clone + Ord,
[src]
type Output = BTreeSet<T>
The resulting type after applying the ^
operator.
fn bitxor(self, rhs: &BTreeSet<T>) -> BTreeSet<T>
[src]
Returns the symmetric difference of self
and rhs
as a new BTreeSet<T>
.
impl<T> Clone for BTreeSet<T> where
T: Clone,
[src]
impl<T> Debug for BTreeSet<T> where
T: Debug,
[src]
impl<T> Default for BTreeSet<T> where
T: Ord,
[src]
impl<T> Eq for BTreeSet<T> where
T: Eq,
[src]
impl<'a, T> Extend<&'a T> for BTreeSet<T> where
T: 'a + Ord + Copy,
[src]1.2.0
fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a T>,
[src]
fn extend_one(&mut self, &'a T)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]
impl<T> Extend<T> for BTreeSet<T> where
T: Ord,
[src]
fn extend<Iter>(&mut self, iter: Iter) where
Iter: IntoIterator<Item = T>,
[src]
fn extend_one(&mut self, elem: T)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]
impl<T> FromIterator<T> for BTreeSet<T> where
T: Ord,
[src]
fn from_iter<I>(iter: I) -> BTreeSet<T> where
I: IntoIterator<Item = T>,
[src]
impl<T> Hash for BTreeSet<T> where
T: Hash,
[src]
fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
[src]1.3.0
impl<'a, T> IntoIterator for &'a BTreeSet<T>
[src]
type Item = &'a T
The type of the elements being iterated over.
type IntoIter = Iter<'a, T>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Iter<'a, T>ⓘ
[src]
impl<T> IntoIterator for BTreeSet<T>
[src]
type Item = T
The type of the elements being iterated over.
type IntoIter = IntoIter<T>
Which kind of iterator are we turning this into?
fn into_iter(self) -> IntoIter<T>ⓘ
[src]
impl<T> Ord for BTreeSet<T> where
T: Ord,
[src]
fn cmp(&self, other: &BTreeSet<T>) -> Ordering
[src]
fn max(self, other: Self) -> Self
[src]1.21.0
fn min(self, other: Self) -> Self
[src]1.21.0
fn clamp(self, min: Self, max: Self) -> Self
[src]
impl<T> PartialEq<BTreeSet<T>> for BTreeSet<T> where
T: PartialEq<T>,
[src]
impl<T> PartialOrd<BTreeSet<T>> for BTreeSet<T> where
T: PartialOrd<T>,
[src]
fn partial_cmp(&self, other: &BTreeSet<T>) -> Option<Ordering>
[src]
fn lt(&self, other: &BTreeSet<T>) -> bool
[src]
fn le(&self, other: &BTreeSet<T>) -> bool
[src]
fn gt(&self, other: &BTreeSet<T>) -> bool
[src]
fn ge(&self, other: &BTreeSet<T>) -> bool
[src]
impl<T> StructuralEq for BTreeSet<T>
[src]
impl<T> StructuralPartialEq for BTreeSet<T>
[src]
impl<'_, '_, T> Sub<&'_ BTreeSet<T>> for &'_ BTreeSet<T> where
T: Clone + Ord,
[src]
impl<T> RefUnwindSafe for BTreeSet<T> where
T: RefUnwindSafe,
impl<T> Send for BTreeSet<T> where
T: Send,
impl<T> Sync for BTreeSet<T> where
T: Sync,
impl<T> Unpin for BTreeSet<T> where
T: Unpin,
impl<T> UnwindSafe for BTreeSet<T> where
T: RefUnwindSafe + UnwindSafe,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
fn borrow(&self) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
impl<I> IntoIterator for I where
I: Iterator,
[src]
type Item = <I as Iterator>::Item
The type of the elements being iterated over.
type IntoIter = I
Which kind of iterator are we turning this into?
fn into_iter(self) -> I
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/collections/btree_set/struct.BTreeSet.html