pub struct BTreeSet<T, A = Global>{ /* private fields */ }
mtls
only.Expand description
An ordered 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 be encapsulated to the
BTreeSet
that observed the logic error and not result in undefined behavior. This could
include panics, incorrect results, aborts, memory leaks, and non-termination.
Iterators returned by BTreeSet::iter
and BTreeSet::into_iter
produce their items in order, and take worst-case
logarithmic and amortized constant time per item returned.
§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}");
}
A BTreeSet
with a known list of items can be initialized from an array:
use std::collections::BTreeSet;
let set = BTreeSet::from([1, 2, 3]);
Implementations§
source§impl<T, A> BTreeSet<T, A>
impl<T, A> BTreeSet<T, A>
sourcepub const fn new_in(alloc: A) -> BTreeSet<T, A>
🔬This is a nightly-only experimental API. (btreemap_alloc
)
pub const fn new_in(alloc: A) -> BTreeSet<T, A>
btreemap_alloc
)Makes a new BTreeSet
with a reasonable choice of B.
§Examples
use std::collections::BTreeSet;
use std::alloc::Global;
let mut set: BTreeSet<i32> = BTreeSet::new_in(Global);
1.17.0 · sourcepub fn range<K, R>(&self, range: R) -> Range<'_, T> ⓘ
pub fn range<K, R>(&self, range: R) -> Range<'_, T> ⓘ
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.
§Panics
Panics if range start > end
.
Panics if range start == end
and both bounds are Excluded
.
§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());
1.0.0 · sourcepub fn difference<'a>(
&'a self,
other: &'a BTreeSet<T, A>,
) -> Difference<'a, T, A> ⓘwhere
T: Ord,
pub fn difference<'a>(
&'a self,
other: &'a BTreeSet<T, A>,
) -> Difference<'a, T, A> ⓘwhere
T: Ord,
Visits the elements representing the difference,
i.e., the elements 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]);
1.0.0 · sourcepub fn symmetric_difference<'a>(
&'a self,
other: &'a BTreeSet<T, A>,
) -> SymmetricDifference<'a, T> ⓘwhere
T: Ord,
pub fn symmetric_difference<'a>(
&'a self,
other: &'a BTreeSet<T, A>,
) -> SymmetricDifference<'a, T> ⓘwhere
T: Ord,
Visits the elements representing the symmetric difference,
i.e., the elements 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]);
1.0.0 · sourcepub fn intersection<'a>(
&'a self,
other: &'a BTreeSet<T, A>,
) -> Intersection<'a, T, A> ⓘwhere
T: Ord,
pub fn intersection<'a>(
&'a self,
other: &'a BTreeSet<T, A>,
) -> Intersection<'a, T, A> ⓘwhere
T: Ord,
Visits the elements representing the intersection,
i.e., the elements 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]);
1.0.0 · sourcepub fn union<'a>(&'a self, other: &'a BTreeSet<T, A>) -> Union<'a, T> ⓘwhere
T: Ord,
pub fn union<'a>(&'a self, other: &'a BTreeSet<T, A>) -> Union<'a, T> ⓘwhere
T: Ord,
Visits the elements representing the union,
i.e., all the elements 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]);
1.0.0 · sourcepub fn clear(&mut self)where
A: Clone,
pub fn clear(&mut self)where
A: Clone,
Clears the set, removing all elements.
§Examples
use std::collections::BTreeSet;
let mut v = BTreeSet::new();
v.insert(1);
v.clear();
assert!(v.is_empty());
1.0.0 · sourcepub fn contains<Q>(&self, value: &Q) -> bool
pub fn contains<Q>(&self, value: &Q) -> bool
Returns true
if the set contains an element equal to the value.
The value may be any borrowed form of the set’s element type, but the ordering on the borrowed form must match the ordering on the element type.
§Examples
use std::collections::BTreeSet;
let set = BTreeSet::from([1, 2, 3]);
assert_eq!(set.contains(&1), true);
assert_eq!(set.contains(&4), false);
1.9.0 · sourcepub fn get<Q>(&self, value: &Q) -> Option<&T>
pub fn get<Q>(&self, value: &Q) -> Option<&T>
Returns a reference to the element in the set, if any, that is equal to the value.
The value may be any borrowed form of the set’s element type, but the ordering on the borrowed form must match the ordering on the element type.
§Examples
use std::collections::BTreeSet;
let set = BTreeSet::from([1, 2, 3]);
assert_eq!(set.get(&2), Some(&2));
assert_eq!(set.get(&4), None);
1.0.0 · sourcepub fn is_disjoint(&self, other: &BTreeSet<T, A>) -> boolwhere
T: Ord,
pub fn is_disjoint(&self, other: &BTreeSet<T, A>) -> boolwhere
T: Ord,
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::from([1, 2, 3]);
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);
1.0.0 · sourcepub fn is_subset(&self, other: &BTreeSet<T, A>) -> boolwhere
T: Ord,
pub fn is_subset(&self, other: &BTreeSet<T, A>) -> boolwhere
T: Ord,
Returns true
if the set is a subset of another,
i.e., other
contains at least all the elements in self
.
§Examples
use std::collections::BTreeSet;
let sup = BTreeSet::from([1, 2, 3]);
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);
1.0.0 · sourcepub fn is_superset(&self, other: &BTreeSet<T, A>) -> boolwhere
T: Ord,
pub fn is_superset(&self, other: &BTreeSet<T, A>) -> boolwhere
T: Ord,
Returns true
if the set is a superset of another,
i.e., self
contains at least all the elements in other
.
§Examples
use std::collections::BTreeSet;
let sub = BTreeSet::from([1, 2]);
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);
1.66.0 · sourcepub fn first(&self) -> Option<&T>where
T: Ord,
pub fn first(&self) -> Option<&T>where
T: Ord,
Returns a reference to the first element in the set, if any. This element is always the minimum of all elements in the set.
§Examples
Basic usage:
use std::collections::BTreeSet;
let mut set = BTreeSet::new();
assert_eq!(set.first(), None);
set.insert(1);
assert_eq!(set.first(), Some(&1));
set.insert(2);
assert_eq!(set.first(), Some(&1));
1.66.0 · sourcepub fn last(&self) -> Option<&T>where
T: Ord,
pub fn last(&self) -> Option<&T>where
T: Ord,
Returns a reference to the last element in the set, if any. This element is always the maximum of all elements in the set.
§Examples
Basic usage:
use std::collections::BTreeSet;
let mut set = BTreeSet::new();
assert_eq!(set.last(), None);
set.insert(1);
assert_eq!(set.last(), Some(&1));
set.insert(2);
assert_eq!(set.last(), Some(&2));
1.66.0 · sourcepub fn pop_first(&mut self) -> Option<T>where
T: Ord,
pub fn pop_first(&mut self) -> Option<T>where
T: Ord,
Removes the first element from the set and returns it, if any. The first element is always the minimum element in the set.
§Examples
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());
1.66.0 · sourcepub fn pop_last(&mut self) -> Option<T>where
T: Ord,
pub fn pop_last(&mut self) -> Option<T>where
T: Ord,
Removes the last element from the set and returns it, if any. The last element is always the maximum element in the set.
§Examples
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());
1.0.0 · sourcepub fn insert(&mut self, value: T) -> boolwhere
T: Ord,
pub fn insert(&mut self, value: T) -> boolwhere
T: Ord,
Adds a value to the set.
Returns whether the value was newly inserted. That is:
- If the set did not previously contain an equal value,
true
is returned. - If the set already contained an equal value,
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);
1.9.0 · sourcepub fn replace(&mut self, value: T) -> Option<T>where
T: Ord,
pub fn replace(&mut self, value: T) -> Option<T>where
T: Ord,
Adds a value to the set, replacing the existing element, if any, that is equal to the value. Returns the replaced element.
§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);
1.0.0 · sourcepub fn remove<Q>(&mut self, value: &Q) -> bool
pub fn remove<Q>(&mut self, value: &Q) -> bool
If the set contains an element equal to the value, removes it from the set and drops it. Returns whether such an element was present.
The value may be any borrowed form of the set’s element type, but the ordering on the borrowed form must match the ordering on the element 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);
1.9.0 · sourcepub fn take<Q>(&mut self, value: &Q) -> Option<T>
pub fn take<Q>(&mut self, value: &Q) -> Option<T>
Removes and returns the element in the set, if any, that is equal to the value.
The value may be any borrowed form of the set’s element type, but the ordering on the borrowed form must match the ordering on the element type.
§Examples
use std::collections::BTreeSet;
let mut set = BTreeSet::from([1, 2, 3]);
assert_eq!(set.take(&2), Some(2));
assert_eq!(set.take(&2), None);
1.53.0 · sourcepub fn retain<F>(&mut self, f: F)
pub fn retain<F>(&mut self, f: F)
Retains only the elements specified by the predicate.
In other words, remove all elements e
for which f(&e)
returns false
.
The elements are visited in ascending order.
§Examples
use std::collections::BTreeSet;
let mut set = BTreeSet::from([1, 2, 3, 4, 5, 6]);
// Keep only the even numbers.
set.retain(|&k| k % 2 == 0);
assert!(set.iter().eq([2, 4, 6].iter()));
1.11.0 · sourcepub fn append(&mut self, other: &mut BTreeSet<T, A>)
pub fn append(&mut self, other: &mut BTreeSet<T, A>)
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));
1.11.0 · sourcepub fn split_off<Q>(&mut self, value: &Q) -> BTreeSet<T, A>
pub fn split_off<Q>(&mut self, value: &Q) -> BTreeSet<T, A>
Splits the collection into two at the value. Returns a new collection with all elements greater than or equal to the value.
§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));
sourcepub fn extract_if<'a, F>(&'a mut self, pred: F) -> ExtractIf<'a, T, F, A> ⓘ
🔬This is a nightly-only experimental API. (btree_extract_if
)
pub fn extract_if<'a, F>(&'a mut self, pred: F) -> ExtractIf<'a, T, F, A> ⓘ
btree_extract_if
)Creates an iterator that visits all elements in ascending order and uses a closure to determine if an element should be removed.
If the closure returns true
, the element is removed from the set and
yielded. If the closure returns false
, or panics, the element remains
in the set and will not be yielded.
If the returned ExtractIf
is not exhausted, e.g. because it is dropped without iterating
or the iteration short-circuits, then the remaining elements will be retained.
Use retain
with a negated predicate if you do not need the returned iterator.
§Examples
Splitting a set into even and odd values, reusing the original set:
#![feature(btree_extract_if)]
use std::collections::BTreeSet;
let mut set: BTreeSet<i32> = (0..8).collect();
let evens: BTreeSet<_> = set.extract_if(|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]);
1.0.0 · sourcepub fn iter(&self) -> Iter<'_, T> ⓘ
pub fn iter(&self) -> Iter<'_, T> ⓘ
Gets an iterator that visits the elements in the BTreeSet
in ascending
order.
§Examples
use std::collections::BTreeSet;
let set = BTreeSet::from([3, 1, 2]);
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);
1.0.0 (const: unstable) · sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
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);
1.0.0 (const: unstable) · sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
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());
sourcepub fn lower_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, T>
🔬This is a nightly-only experimental API. (btree_cursors
)
pub fn lower_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, T>
btree_cursors
)Returns a Cursor
pointing at the gap before the smallest element
greater than the given bound.
Passing Bound::Included(x)
will return a cursor pointing to the
gap before the smallest element greater than or equal to x
.
Passing Bound::Excluded(x)
will return a cursor pointing to the
gap before the smallest element greater than x
.
Passing Bound::Unbounded
will return a cursor pointing to the
gap before the smallest element in the set.
§Examples
#![feature(btree_cursors)]
use std::collections::BTreeSet;
use std::ops::Bound;
let set = BTreeSet::from([1, 2, 3, 4]);
let cursor = set.lower_bound(Bound::Included(&2));
assert_eq!(cursor.peek_prev(), Some(&1));
assert_eq!(cursor.peek_next(), Some(&2));
let cursor = set.lower_bound(Bound::Excluded(&2));
assert_eq!(cursor.peek_prev(), Some(&2));
assert_eq!(cursor.peek_next(), Some(&3));
let cursor = set.lower_bound(Bound::Unbounded);
assert_eq!(cursor.peek_prev(), None);
assert_eq!(cursor.peek_next(), Some(&1));
sourcepub fn lower_bound_mut<Q>(&mut self, bound: Bound<&Q>) -> CursorMut<'_, T, A>
🔬This is a nightly-only experimental API. (btree_cursors
)
pub fn lower_bound_mut<Q>(&mut self, bound: Bound<&Q>) -> CursorMut<'_, T, A>
btree_cursors
)Returns a CursorMut
pointing at the gap before the smallest element
greater than the given bound.
Passing Bound::Included(x)
will return a cursor pointing to the
gap before the smallest element greater than or equal to x
.
Passing Bound::Excluded(x)
will return a cursor pointing to the
gap before the smallest element greater than x
.
Passing Bound::Unbounded
will return a cursor pointing to the
gap before the smallest element in the set.
§Examples
#![feature(btree_cursors)]
use std::collections::BTreeSet;
use std::ops::Bound;
let mut set = BTreeSet::from([1, 2, 3, 4]);
let mut cursor = set.lower_bound_mut(Bound::Included(&2));
assert_eq!(cursor.peek_prev(), Some(&1));
assert_eq!(cursor.peek_next(), Some(&2));
let mut cursor = set.lower_bound_mut(Bound::Excluded(&2));
assert_eq!(cursor.peek_prev(), Some(&2));
assert_eq!(cursor.peek_next(), Some(&3));
let mut cursor = set.lower_bound_mut(Bound::Unbounded);
assert_eq!(cursor.peek_prev(), None);
assert_eq!(cursor.peek_next(), Some(&1));
sourcepub fn upper_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, T>
🔬This is a nightly-only experimental API. (btree_cursors
)
pub fn upper_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, T>
btree_cursors
)Returns a Cursor
pointing at the gap after the greatest element
smaller than the given bound.
Passing Bound::Included(x)
will return a cursor pointing to the
gap after the greatest element smaller than or equal to x
.
Passing Bound::Excluded(x)
will return a cursor pointing to the
gap after the greatest element smaller than x
.
Passing Bound::Unbounded
will return a cursor pointing to the
gap after the greatest element in the set.
§Examples
#![feature(btree_cursors)]
use std::collections::BTreeSet;
use std::ops::Bound;
let set = BTreeSet::from([1, 2, 3, 4]);
let cursor = set.upper_bound(Bound::Included(&3));
assert_eq!(cursor.peek_prev(), Some(&3));
assert_eq!(cursor.peek_next(), Some(&4));
let cursor = set.upper_bound(Bound::Excluded(&3));
assert_eq!(cursor.peek_prev(), Some(&2));
assert_eq!(cursor.peek_next(), Some(&3));
let cursor = set.upper_bound(Bound::Unbounded);
assert_eq!(cursor.peek_prev(), Some(&4));
assert_eq!(cursor.peek_next(), None);
sourcepub unsafe fn upper_bound_mut<Q>(
&mut self,
bound: Bound<&Q>,
) -> CursorMut<'_, T, A>
🔬This is a nightly-only experimental API. (btree_cursors
)
pub unsafe fn upper_bound_mut<Q>( &mut self, bound: Bound<&Q>, ) -> CursorMut<'_, T, A>
btree_cursors
)Returns a CursorMut
pointing at the gap after the greatest element
smaller than the given bound.
Passing Bound::Included(x)
will return a cursor pointing to the
gap after the greatest element smaller than or equal to x
.
Passing Bound::Excluded(x)
will return a cursor pointing to the
gap after the greatest element smaller than x
.
Passing Bound::Unbounded
will return a cursor pointing to the
gap after the greatest element in the set.
§Examples
#![feature(btree_cursors)]
use std::collections::BTreeSet;
use std::ops::Bound;
let mut set = BTreeSet::from([1, 2, 3, 4]);
let mut cursor = unsafe { set.upper_bound_mut(Bound::Included(&3)) };
assert_eq!(cursor.peek_prev(), Some(&3));
assert_eq!(cursor.peek_next(), Some(&4));
let mut cursor = unsafe { set.upper_bound_mut(Bound::Excluded(&3)) };
assert_eq!(cursor.peek_prev(), Some(&2));
assert_eq!(cursor.peek_next(), Some(&3));
let mut cursor = unsafe { set.upper_bound_mut(Bound::Unbounded) };
assert_eq!(cursor.peek_prev(), Some(&4));
assert_eq!(cursor.peek_next(), None);
Trait Implementations§
source§impl<K> Accumulate<K> for BTreeSet<K>where
K: Ord,
impl<K> Accumulate<K> for BTreeSet<K>where
K: Ord,
1.0.0 · source§impl<T, A> BitAnd<&BTreeSet<T, A>> for &BTreeSet<T, A>
impl<T, A> BitAnd<&BTreeSet<T, A>> for &BTreeSet<T, A>
source§fn bitand(self, rhs: &BTreeSet<T, A>) -> BTreeSet<T, A>
fn bitand(self, rhs: &BTreeSet<T, A>) -> BTreeSet<T, A>
Returns the intersection of self
and rhs
as a new BTreeSet<T>
.
§Examples
use std::collections::BTreeSet;
let a = BTreeSet::from([1, 2, 3]);
let b = BTreeSet::from([2, 3, 4]);
let result = &a & &b;
assert_eq!(result, BTreeSet::from([2, 3]));
1.0.0 · source§impl<T, A> BitOr<&BTreeSet<T, A>> for &BTreeSet<T, A>
impl<T, A> BitOr<&BTreeSet<T, A>> for &BTreeSet<T, A>
source§fn bitor(self, rhs: &BTreeSet<T, A>) -> BTreeSet<T, A>
fn bitor(self, rhs: &BTreeSet<T, A>) -> BTreeSet<T, A>
Returns the union of self
and rhs
as a new BTreeSet<T>
.
§Examples
use std::collections::BTreeSet;
let a = BTreeSet::from([1, 2, 3]);
let b = BTreeSet::from([3, 4, 5]);
let result = &a | &b;
assert_eq!(result, BTreeSet::from([1, 2, 3, 4, 5]));
1.0.0 · source§impl<T, A> BitXor<&BTreeSet<T, A>> for &BTreeSet<T, A>
impl<T, A> BitXor<&BTreeSet<T, A>> for &BTreeSet<T, A>
source§fn bitxor(self, rhs: &BTreeSet<T, A>) -> BTreeSet<T, A>
fn bitxor(self, rhs: &BTreeSet<T, A>) -> BTreeSet<T, A>
Returns the symmetric difference of self
and rhs
as a new BTreeSet<T>
.
§Examples
use std::collections::BTreeSet;
let a = BTreeSet::from([1, 2, 3]);
let b = BTreeSet::from([2, 3, 4]);
let result = &a ^ &b;
assert_eq!(result, BTreeSet::from([1, 4]));
source§impl<T> CheckDerConstraints for BTreeSet<T>where
T: CheckDerConstraints,
impl<T> CheckDerConstraints for BTreeSet<T>where
T: CheckDerConstraints,
source§impl<'de, T> Deserialize<'de> for BTreeSet<T>
impl<'de, T> Deserialize<'de> for BTreeSet<T>
source§fn deserialize<D>(
deserializer: D,
) -> Result<BTreeSet<T>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D,
) -> Result<BTreeSet<T>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
1.2.0 · source§impl<'a, T, A> Extend<&'a T> for BTreeSet<T, A>
impl<'a, T, A> Extend<&'a T> for BTreeSet<T, A>
source§fn extend<I>(&mut self, iter: I)where
I: IntoIterator<Item = &'a T>,
fn extend<I>(&mut self, iter: I)where
I: IntoIterator<Item = &'a T>,
source§fn extend_one(&mut self, _: &'a T)
fn extend_one(&mut self, _: &'a T)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)1.0.0 · source§impl<T, A> Extend<T> for BTreeSet<T, A>
impl<T, A> Extend<T> for BTreeSet<T, A>
source§fn extend<Iter>(&mut self, iter: Iter)where
Iter: IntoIterator<Item = T>,
fn extend<Iter>(&mut self, iter: Iter)where
Iter: IntoIterator<Item = T>,
source§fn extend_one(&mut self, elem: T)
fn extend_one(&mut self, elem: T)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl<'a, T, E> FromDer<'a, E> for BTreeSet<T>
impl<'a, T, E> FromDer<'a, E> for BTreeSet<T>
manual impl of FromDer, so we do not need to require TryFrom<Any> + CheckDerConstraints
1.0.0 · source§impl<T> FromIterator<T> for BTreeSet<T>where
T: Ord,
impl<T> FromIterator<T> for BTreeSet<T>where
T: Ord,
source§impl<'de, T, E> IntoDeserializer<'de, E> for BTreeSet<T>
impl<'de, T, E> IntoDeserializer<'de, E> for BTreeSet<T>
source§type Deserializer = SeqDeserializer<<BTreeSet<T> as IntoIterator>::IntoIter, E>
type Deserializer = SeqDeserializer<<BTreeSet<T> as IntoIterator>::IntoIter, E>
source§fn into_deserializer(
self,
) -> <BTreeSet<T> as IntoDeserializer<'de, E>>::Deserializer
fn into_deserializer( self, ) -> <BTreeSet<T> as IntoDeserializer<'de, E>>::Deserializer
1.0.0 · source§impl<'a, T, A> IntoIterator for &'a BTreeSet<T, A>
impl<'a, T, A> IntoIterator for &'a BTreeSet<T, A>
1.0.0 · source§impl<T, A> IntoIterator for BTreeSet<T, A>
impl<T, A> IntoIterator for BTreeSet<T, A>
1.0.0 · source§impl<T, A> Ord for BTreeSet<T, A>
impl<T, A> Ord for BTreeSet<T, A>
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
1.0.0 · source§impl<T, A> PartialOrd for BTreeSet<T, A>
impl<T, A> PartialOrd for BTreeSet<T, A>
source§impl<T> Serialize for BTreeSet<T>where
T: Serialize,
impl<T> Serialize for BTreeSet<T>where
T: Serialize,
source§fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
1.0.0 · source§impl<T, A> Sub<&BTreeSet<T, A>> for &BTreeSet<T, A>
impl<T, A> Sub<&BTreeSet<T, A>> for &BTreeSet<T, A>
source§impl<T> ToDer for BTreeSet<T>where
T: ToDer,
impl<T> ToDer for BTreeSet<T>where
T: ToDer,
source§fn to_der_len(&self) -> Result<usize, Error>
fn to_der_len(&self) -> Result<usize, Error>
source§fn write_der_header(
&self,
writer: &mut dyn Write,
) -> Result<usize, SerializeError>
fn write_der_header( &self, writer: &mut dyn Write, ) -> Result<usize, SerializeError>
source§fn write_der_content(
&self,
writer: &mut dyn Write,
) -> Result<usize, SerializeError>
fn write_der_content( &self, writer: &mut dyn Write, ) -> Result<usize, SerializeError>
source§fn to_der_vec(&self) -> Result<Vec<u8>, SerializeError>
fn to_der_vec(&self) -> Result<Vec<u8>, SerializeError>
Vec<u8>
.source§fn to_der_vec_raw(&self) -> Result<Vec<u8>, SerializeError>
fn to_der_vec_raw(&self) -> Result<Vec<u8>, SerializeError>
to_vec
, but uses provided values without changes.
This can generate an invalid encoding for a DER object.source§fn write_der(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>
fn write_der(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>
source§fn write_der_raw(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>
fn write_der_raw(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>
to_der
, but uses provided values without changes.
This can generate an invalid encoding for a DER object.impl<T, A> Eq for BTreeSet<T, A>
Auto Trait Implementations§
impl<T, A> Freeze for BTreeSet<T, A>where
A: Freeze,
impl<T, A> RefUnwindSafe for BTreeSet<T, A>where
A: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, A> Send for BTreeSet<T, A>
impl<T, A> Sync for BTreeSet<T, A>
impl<T, A> Unpin for BTreeSet<T, A>where
A: Unpin,
impl<T, A> UnwindSafe for BTreeSet<T, A>where
A: UnwindSafe,
T: RefUnwindSafe,
Blanket Implementations§
source§impl<T> AsAny for Twhere
T: Any,
impl<T> AsAny for Twhere
T: Any,
fn as_any_ref(&self) -> &(dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<A, T> Collection<A> for T
impl<A, T> Collection<A> for T
source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);