# Struct std::collections::btree_set::BTreeSet 1.0.0[−][src]

    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. The behavior resulting from such a logic error is not specified, but will not result in undefined behavior. This could include panics, incorrect results, aborts, memory leaks, and non-termination.

# Examples

    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);
    }

Run

## Implementations

### `impl<T> BTreeSet<T>`[src]

#### `pub fn new() -> BTreeSet<T> where
T: Ord,` [src]

Makes a new, empty `BTreeSet`.

Does not allocate anything on its own.

# Examples

    use std::collections::BTreeSet;

    let mut set: BTreeSet<i32> = BTreeSet::new();

Run

#### `pub fn range<K, R>(&self, range: R) -> Range<'_, T>ⓘ

### Notable traits for Range<'a, T>

`impl<'a, T> Iterator for Range<'a, T> type Item = &'a T;`
where
T: Borrow<K> + Ord,
R: RangeBounds<K>,
K: Ord + ?Sized,` 1.17.0[src]

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.

# Examples

    use std::collections::BTreeSet;
    use std::ops::Bound::Included;

    let mut set = BTreeSet::new();
    set.insert(3);
    set.insert(5);
    set.insert(8);
    for &elem in set.range((Included(&4), Included(&8))) {
        println!("{}", elem);
    }
    assert_eq!(Some(&5), set.range(4..).next());

Run

#### `pub fn difference(&'a self, other: &'a BTreeSet<T>) -> Difference<'a, T>ⓘ

### Notable traits for Difference<'a, T>

`impl<'a, T> Iterator for Difference<'a, T> where
T: Ord, type Item = &'a T;`
where
T: Ord,` [src]

Visits the values representing the difference, i.e., the values that are in `self` but not in `other`, in ascending order.

# Examples

    use std::collections::BTreeSet;

    let mut a = BTreeSet::new();
    a.insert(1);
    a.insert(2);

    let mut b = BTreeSet::new();
    b.insert(2);
    b.insert(3);

    let diff: Vec<_> = a.difference(&b).cloned().collect();
    assert_eq!(diff, [1]);

Run

#### `pub fn symmetric_difference(
&'a self,
other: &'a BTreeSet<T>
) -> SymmetricDifference<'a, T>ⓘ

### Notable traits for SymmetricDifference<'a, T>

`impl<'a, T> Iterator for SymmetricDifference<'a, T> where
T: Ord, type Item = &'a T;`
where
T: Ord,` [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.

# Examples

    use std::collections::BTreeSet;

    let mut a = BTreeSet::new();
    a.insert(1);
    a.insert(2);

    let mut b = BTreeSet::new();
    b.insert(2);
    b.insert(3);

    let sym_diff: Vec<_> = a.symmetric_difference(&b).cloned().collect();
    assert_eq!(sym_diff, [1, 3]);

Run

#### `pub fn intersection(&'a self, other: &'a BTreeSet<T>) -> Intersection<'a, T>ⓘ

### Notable traits for Intersection<'a, T>

`impl<'a, T> Iterator for Intersection<'a, T> where
T: Ord, type Item = &'a T;`
where
T: Ord,` [src]

Visits the values representing the intersection, i.e., the values that are both in `self` and `other`, in ascending order.

# Examples

    use std::collections::BTreeSet;

    let mut a = BTreeSet::new();
    a.insert(1);
    a.insert(2);

    let mut b = BTreeSet::new();
    b.insert(2);
    b.insert(3);

    let intersection: Vec<_> = a.intersection(&b).cloned().collect();
    assert_eq!(intersection, [2]);

Run

#### `pub fn union(&'a self, other: &'a BTreeSet<T>) -> Union<'a, T>ⓘ

### Notable traits for Union<'a, T>

`impl<'a, T> Iterator for Union<'a, T> where
T: Ord, type Item = &'a T;`
where
T: Ord,` [src]

Visits the values representing the union, i.e., all the values in `self` or `other`, without duplicates, in ascending order.

# Examples

    use std::collections::BTreeSet;

    let mut a = BTreeSet::new();
    a.insert(1);

    let mut b = BTreeSet::new();
    b.insert(2);

    let union: Vec<_> = a.union(&b).cloned().collect();
    assert_eq!(union, [1, 2]);

Run

#### `pub fn clear(&mut self) where
T: Ord,` [src]

Clears the set, removing all values.

# Examples

    use std::collections::BTreeSet;

    let mut v = BTreeSet::new();
    v.insert(1);
    v.clear();
    assert!(v.is_empty());

Run

#### `pub fn contains<Q>(&self, value: &Q) -> bool where
T: Borrow<Q> + Ord,
Q: Ord + ?Sized,` [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.

# Examples

    use std::collections::BTreeSet;

    let set: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
    assert_eq!(set.contains(&1), true);
    assert_eq!(set.contains(&4), false);

Run

#### `pub fn get<Q>(&self, value: &Q) -> Option<&T> where
T: Borrow<Q> + Ord,
Q: Ord + ?Sized,` 1.9.0[src]

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.

# Examples

    use std::collections::BTreeSet;

    let set: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
    assert_eq!(set.get(&2), Some(&2));
    assert_eq!(set.get(&4), None);

Run

#### `pub fn is_disjoint(&self, other: &BTreeSet<T>) -> bool where
T: Ord,` [src]

Returns `true` if `self` has no elements in common with `other`. This is equivalent to checking for an empty intersection.

# Examples

    use std::collections::BTreeSet;

    let a: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
    let mut b = BTreeSet::new();

    assert_eq!(a.is_disjoint(&b), true);
    b.insert(4);
    assert_eq!(a.is_disjoint(&b), true);
    b.insert(1);
    assert_eq!(a.is_disjoint(&b), false);

Run

#### `pub fn is_subset(&self, other: &BTreeSet<T>) -> bool where
T: Ord,` [src]

Returns `true` if the set is a subset of another, i.e., `other` contains at least all the values in `self`.

# Examples

    use std::collections::BTreeSet;

    let sup: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
    let mut set = BTreeSet::new();

    assert_eq!(set.is_subset(&sup), true);
    set.insert(2);
    assert_eq!(set.is_subset(&sup), true);
    set.insert(4);
    assert_eq!(set.is_subset(&sup), false);

Run

#### `pub fn is_superset(&self, other: &BTreeSet<T>) -> bool where
T: Ord,` [src]

Returns `true` if the set is a superset of another, i.e., `self` contains at least all the values in `other`.

# Examples

    use std::collections::BTreeSet;

    let sub: BTreeSet<_> = [1, 2].iter().cloned().collect();
    let mut set = BTreeSet::new();

    assert_eq!(set.is_superset(&sub), false);

    set.insert(0);
    set.insert(1);
    assert_eq!(set.is_superset(&sub), false);

    set.insert(2);
    assert_eq!(set.is_superset(&sub), true);

Run

#### `pub fn first(&self) -> Option<&T> where
T: Ord,` [src]

🔬 This is a nightly-only experimental API. (`map_first_last` #62924)

Returns a reference to the first value in the set, if any. This value is always the minimum of all values in the set.

# Examples

Basic usage:

    #![feature(map_first_last)]
    use std::collections::BTreeSet;

    let mut map = BTreeSet::new();
    assert_eq!(map.first(), None);
    map.insert(1);
    assert_eq!(map.first(), Some(&1));
    map.insert(2);
    assert_eq!(map.first(), Some(&1));

Run

#### `pub fn last(&self) -> Option<&T> where
T: Ord,` [src]

🔬 This is a nightly-only experimental API. (`map_first_last` #62924)

Returns a reference to the last value in the set, if any. This value is always the maximum of all values in the set.

# Examples

Basic usage:

    #![feature(map_first_last)]
    use std::collections::BTreeSet;

    let mut map = BTreeSet::new();
    assert_eq!(map.first(), None);
    map.insert(1);
    assert_eq!(map.last(), Some(&1));
    map.insert(2);
    assert_eq!(map.last(), Some(&2));

Run

#### `pub fn pop_first(&mut self) -> Option<T> where
T: Ord,` [src]

🔬 This is a nightly-only experimental API. (`map_first_last` #62924)

Removes the first value from the set and returns it, if any. The first value is always the minimum value in the set.

# Examples

    #![feature(map_first_last)]
    use std::collections::BTreeSet;

    let mut set = BTreeSet::new();

    set.insert(1);
    while let Some(n) = set.pop_first() {
        assert_eq!(n, 1);
    }
    assert!(set.is_empty());

Run

#### `pub fn pop_last(&mut self) -> Option<T> where
T: Ord,` [src]

🔬 This is a nightly-only experimental API. (`map_first_last` #62924)

Removes the last value from the set and returns it, if any. The last value is always the maximum value in the set.

# Examples

    #![feature(map_first_last)]
    use std::collections::BTreeSet;

    let mut set = BTreeSet::new();

    set.insert(1);
    while let Some(n) = set.pop_last() {
        assert_eq!(n, 1);
    }
    assert!(set.is_empty());

Run

#### `pub fn insert(&mut self, value: T) -> bool where
T: Ord,` [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.

# Examples

    use std::collections::BTreeSet;

    let mut set = BTreeSet::new();

    assert_eq!(set.insert(2), true);
    assert_eq!(set.insert(2), false);
    assert_eq!(set.len(), 1);

Run

#### `pub fn replace(&mut self, value: T) -> Option<T> where
T: Ord,` 1.9.0[src]

Adds a value to the set, replacing the existing value, if any, that is equal to the given one. Returns the replaced value.

# Examples

    use std::collections::BTreeSet;

    let mut set = BTreeSet::new();
    set.insert(Vec::<i32>::new());

    assert_eq!(set.get(&[][..]).unwrap().capacity(), 0);
    set.replace(Vec::with_capacity(10));
    assert_eq!(set.get(&[][..]).unwrap().capacity(), 10);

Run

#### `pub fn remove<Q>(&mut self, value: &Q) -> bool where
T: Borrow<Q> + Ord,
Q: Ord + ?Sized,` [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.

# Examples

    use std::collections::BTreeSet;

    let mut set = BTreeSet::new();

    set.insert(2);
    assert_eq!(set.remove(&2), true);
    assert_eq!(set.remove(&2), false);

Run

#### `pub fn take<Q>(&mut self, value: &Q) -> Option<T> where
T: Borrow<Q> + Ord,
Q: Ord + ?Sized,` 1.9.0[src]

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.

# Examples

    use std::collections::BTreeSet;

    let mut set: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
    assert_eq!(set.take(&2), Some(2));
    assert_eq!(set.take(&2), None);

Run

#### `pub fn retain<F>(&mut self, f: F) where
F: FnMut(&T) -> bool,
T: Ord,` [src]

🔬 This is a nightly-only experimental API. (`btree_retain` #79025)

Retains only the elements specified by the predicate.

In other words, remove all elements `e` such that `f(&e)` returns `false`.

# Examples

    #![feature(btree_retain)]
    use std::collections::BTreeSet;

    let xs = [1, 2, 3, 4, 5, 6];
    let mut set: BTreeSet<i32> = xs.iter().cloned().collect();
    // Keep only the even numbers.
    set.retain(|&k| k % 2 == 0);
    assert!(set.iter().eq([2, 4, 6].iter()));

Run

#### `pub fn append(&mut self, other: &mut BTreeSet<T>) where
T: Ord,` 1.11.0[src]

Moves all elements from `other` into `Self`, leaving `other` empty.

# Examples

    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));

Run

#### `pub fn split_off<Q>(&mut self, key: &Q) -> BTreeSet<T> where
T: Borrow<Q> + Ord,
Q: Ord + ?Sized,` 1.11.0[src]

Splits the collection into two at the given key. Returns everything after the given key, including the key.

# Examples

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));

Run

#### `pub fn drain_filter<'a, F>(&'a mut self, pred: F) -> DrainFilter<'a, T, F>ⓘ

### Notable traits for DrainFilter<'_, T, F>

`impl<'a, '_, T, F> Iterator for DrainFilter<'_, T, F> where
F: 'a + FnMut(&T) -> bool, type Item = T;`
where
F: 'a + FnMut(&T) -> bool,
T: Ord,` [src]

🔬 This is a nightly-only experimental API. (`btree_drain_filter` #70530)

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.

# Examples

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]);

Run

#### `pub fn iter(&self) -> Iter<'_, T>ⓘ

### Notable traits for Iter<'a, T>

`impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;`
`[src]

Gets an iterator that visits the values in the `BTreeSet` in ascending order.

# Examples

    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);

Run

Values returned by the iterator are returned in ascending order:

    use std::collections::BTreeSet;

    let set: BTreeSet<usize> = [3, 1, 2].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);

Run

#### `pub fn len(&self) -> usize`[src]

Returns the number of elements in the set.

# Examples

    use std::collections::BTreeSet;

    let mut v = BTreeSet::new();
    assert_eq!(v.len(), 0);
    v.insert(1);
    assert_eq!(v.len(), 1);

Run

#### `pub fn is_empty(&self) -> bool`[src]

Returns `true` if the set contains no elements.

# Examples

    use std::collections::BTreeSet;

    let mut v = BTreeSet::new();
    assert!(v.is_empty());
    v.insert(1);
    assert!(!v.is_empty());

Run

## Trait Implementations

### `impl<'_, '_, T> BitAnd<&'_ BTreeSet<T>> for &'_ BTreeSet<T> where
T: Clone + Ord,` [src]

#### `type Output = BTreeSet<T>`

The resulting type after applying the `&` operator.

#### `pub fn bitand(self, rhs: &BTreeSet<T>) -> BTreeSet<T>`[src]

Returns the intersection of `self` and `rhs` as a new `BTreeSet<T>`.

# Examples

    use std::collections::BTreeSet;

    let a: BTreeSet<_> = vec![1, 2, 3].into_iter().collect();
    let b: BTreeSet<_> = vec![2, 3, 4].into_iter().collect();

    let result = &a & &b;
    let result_vec: Vec<_> = result.into_iter().collect();
    assert_eq!(result_vec, [2, 3]);

Run

### `impl<'_, '_, T> BitOr<&'_ BTreeSet<T>> for &'_ BTreeSet<T> where
T: Clone + Ord,` [src]

#### `type Output = BTreeSet<T>`

The resulting type after applying the `|` operator.

#### `pub fn bitor(self, rhs: &BTreeSet<T>) -> BTreeSet<T>`[src]

Returns the union of `self` and `rhs` as a new `BTreeSet<T>`.

# Examples

    use std::collections::BTreeSet;

    let a: BTreeSet<_> = vec![1, 2, 3].into_iter().collect();
    let b: BTreeSet<_> = vec![3, 4, 5].into_iter().collect();

    let result = &a | &b;
    let result_vec: Vec<_> = result.into_iter().collect();
    assert_eq!(result_vec, [1, 2, 3, 4, 5]);

Run

### `impl<'_, '_, T> BitXor<&'_ BTreeSet<T>> for &'_ BTreeSet<T> where
T: Clone + Ord,` [src]

#### `type Output = BTreeSet<T>`

The resulting type after applying the `^` operator.

#### `pub fn bitxor(self, rhs: &BTreeSet<T>) -> BTreeSet<T>`[src]

Returns the symmetric difference of `self` and `rhs` as a new `BTreeSet<T>`.

# Examples

    use std::collections::BTreeSet;

    let a: BTreeSet<_> = vec![1, 2, 3].into_iter().collect();
    let b: BTreeSet<_> = vec![2, 3, 4].into_iter().collect();

    let result = &a ^ &b;
    let result_vec: Vec<_> = result.into_iter().collect();
    assert_eq!(result_vec, [1, 4]);

Run

### `impl<T> Clone for BTreeSet<T> where
T: Clone,` [src]

#### `pub fn clone(&self) -> BTreeSet<T>`[src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, other: &BTreeSet<T>)`[src]

Performs copy-assignment from `source`. Read more

### `impl<T> Debug for BTreeSet<T> where
T: Debug,` [src]

#### `pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter. Read more

### `impl<T> Default for BTreeSet<T> where
T: Ord,` [src]

#### `pub fn default() -> BTreeSet<T>`[src]

Creates an empty `BTreeSet`.

### `impl<T> Eq for BTreeSet<T> where
T: Eq,` [src]

### `impl<'a, T> Extend<&'a T> for BTreeSet<T> where
T: 'a + Ord + Copy,` 1.2.0[src]

#### `pub fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a T>,` [src]

Extends a collection with the contents of an iterator. Read more

#### `pub fn extend_one(&mut self, &'a T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

Extends a collection with exactly one element.

#### `pub fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

Reserves capacity in a collection for the given number of additional elements. Read more

### `impl<T> Extend<T> for BTreeSet<T> where
T: Ord,` [src]

#### `pub fn extend<Iter>(&mut self, iter: Iter) where
Iter: IntoIterator<Item = T>,` [src]

Extends a collection with the contents of an iterator. Read more

#### `pub fn extend_one(&mut self, elem: T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

Extends a collection with exactly one element.

#### `pub fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

Reserves capacity in a collection for the given number of additional elements. Read more

### `impl<T> FromIterator<T> for BTreeSet<T> where
T: Ord,` [src]

#### `pub fn from_iter<I>(iter: I) -> BTreeSet<T> where
I: IntoIterator<Item = T>,` [src]

Creates a value from an iterator. Read more

### `impl<T> Hash for BTreeSet<T> where
T: Hash,` [src]

#### `pub fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,` [src]

Feeds this value into the given `Hasher`. Read more

#### `pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,` 1.3.0[src]

Feeds a slice of this type into the given `Hasher`. Read more

### `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?

#### `pub fn into_iter(self) -> IntoIter<T>ⓘ

### Notable traits for IntoIter<T>

`impl<T> Iterator for IntoIter<T> type Item = T;`
`[src]

Gets an iterator for moving out the `BTreeSet`'s contents.

# Examples

    use std::collections::BTreeSet;

    let set: BTreeSet<usize> = [1, 2, 3, 4].iter().cloned().collect();

    let v: Vec<_> = set.into_iter().collect();
    assert_eq!(v, [1, 2, 3, 4]);

Run

### `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?

#### `pub fn into_iter(self) -> Iter<'a, T>ⓘ

### Notable traits for Iter<'a, T>

`impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;`
`[src]

Creates an iterator from a value. Read more

### `impl<T> Ord for BTreeSet<T> where
T: Ord,` [src]

#### `pub fn cmp(&self, other: &BTreeSet<T>) -> Ordering`[src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `#[must_use]pub fn max(self, other: Self) -> Self` 1.21.0[src]

Compares and returns the maximum of two values. Read more

#### `#[must_use]pub fn min(self, other: Self) -> Self` 1.21.0[src]

Compares and returns the minimum of two values. Read more

#### `#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self` 1.50.0[src]

Restrict a value to a certain interval. Read more

### `impl<T> PartialEq<BTreeSet<T>> for BTreeSet<T> where
T: PartialEq<T>,` [src]

#### `pub fn eq(&self, other: &BTreeSet<T>) -> bool`[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `pub fn ne(&self, other: &BTreeSet<T>) -> bool`[src]

This method tests for `!=`.

### `impl<T> PartialOrd<BTreeSet<T>> for BTreeSet<T> where
T: PartialOrd<T>,` [src]

#### `pub fn partial_cmp(&self, other: &BTreeSet<T>) -> Option<Ordering>`[src]

This method returns an ordering between `self` and `other` values if one exists. Read more

#### `pub fn lt(&self, other: &BTreeSet<T>) -> bool`[src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `pub fn le(&self, other: &BTreeSet<T>) -> bool`[src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `pub fn gt(&self, other: &BTreeSet<T>) -> bool`[src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

#### `pub fn ge(&self, other: &BTreeSet<T>) -> bool`[src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

### `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]

#### `type Output = BTreeSet<T>`

The resulting type after applying the `-` operator.

#### `pub fn sub(self, rhs: &BTreeSet<T>) -> BTreeSet<T>`[src]

Returns the difference of `self` and `rhs` as a new `BTreeSet<T>`.

# Examples

    use std::collections::BTreeSet;

    let a: BTreeSet<_> = vec![1, 2, 3].into_iter().collect();
    let b: BTreeSet<_> = vec![3, 4, 5].into_iter().collect();

    let result = &a - &b;
    let result_vec: Vec<_> = result.into_iter().collect();
    assert_eq!(result_vec, [1, 2]);

Run

## Auto Trait Implementations

### `impl<T> RefUnwindSafe for BTreeSet<T> where
T: RefUnwindSafe,` [src]

### `impl<T> Send for BTreeSet<T> where
T: Send,` [src]

### `impl<T> Sync for BTreeSet<T> where
T: Sync,` [src]

### `impl<T> Unpin for BTreeSet<T>`[src]

### `impl<T> UnwindSafe for BTreeSet<T> where
T: RefUnwindSafe,` [src]

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub 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 Rimpl<W: Write + ?Sized> Write for &mut W`
`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub 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 Rimpl<W: Write + ?Sized> Write for &mut W`
`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `pub fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `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.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.