Struct frame_support::BoundedBTreeSet

pub struct BoundedBTreeSet<T, S>(/* private fields */);

A bounded set based on a B-Tree.

B-Trees represent a fundamental compromise between cache-efficiency and actually minimizing the amount of work performed in a search. See BTreeSet for more details.

Unlike a standard BTreeSet, there is an enforced upper limit to the number of items in the set. All internal operations ensure this bound is respected.

Implementations

impl<T, S> BoundedBTreeSet<T, S>

where S: Get<u32>,

pub fn bound() -> usize

Get the bound of the type in usize.

impl<T, S> BoundedBTreeSet<T, S>

where T: Ord, S: Get<u32>,

pub fn new() -> BoundedBTreeSet<T, S>

Create a new BoundedBTreeSet.

Does not allocate.

pub fn into_inner(self) -> BTreeSet<T>

Consume self, and return the inner BTreeSet.

This is useful when a mutating API of the inner type is desired, and closure-based mutation such as provided by try_mutate is inconvenient.

pub fn try_mutate( self, mutate: impl FnMut(&mut BTreeSet<T>), ) -> Option<BoundedBTreeSet<T, S>>

Consumes self and mutates self via the given mutate function.

If the outcome of mutation is within bounds, Some(Self) is returned. Else, None is returned.

This is essentially a consuming shorthand Self::into_inner -> ... -> Self::try_from.

pub fn clear(&mut self)

Clears the set, removing all elements.

pub fn try_insert(&mut self, item: T) -> Result<bool, T>

Exactly the same semantics as BTreeSet::insert, but returns an Err (and is a noop) if the new length of the set exceeds S.

In the Err case, returns the inserted item so it can be further used without cloning.

pub fn remove<Q>(&mut self, item: &Q) -> bool

where T: Borrow<Q>, Q: Ord + ?Sized,

Remove an item from the set, returning whether it was previously in the set.

The item may be any borrowed form of the set’s item type, but the ordering on the borrowed form must match the ordering on the item type.

pub fn take<Q>(&mut self, value: &Q) -> Option<T>

where T: Borrow<Q> + Ord, Q: Ord + ?Sized,

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.

Methods from Deref<Target = BTreeSet<T>>

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

where K: Ord + ?Sized, T: Borrow<K> + Ord, R: RangeBounds<K>,

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

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

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

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

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

pub fn contains<Q>(&self, value: &Q) -> bool

where T: Borrow<Q> + Ord, Q: Ord + ?Sized,

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

pub fn get<Q>(&self, value: &Q) -> Option<&T>

where T: Borrow<Q> + Ord, Q: Ord + ?Sized,

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

pub fn is_disjoint(&self, other: &BTreeSet<T, A>) -> bool

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

pub fn is_subset(&self, other: &BTreeSet<T, A>) -> bool

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

pub fn is_superset(&self, other: &BTreeSet<T, A>) -> bool

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

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

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

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

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

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

Trait Implementations

impl<T, S> AsRef<BTreeSet<T>> for BoundedBTreeSet<T, S>

where T: Ord,

fn as_ref(&self) -> &BTreeSet<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, S> Clone for BoundedBTreeSet<T, S>

where BTreeSet<T>: Clone,

fn clone(&self) -> BoundedBTreeSet<T, S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, S> Debug for BoundedBTreeSet<T, S>

where BTreeSet<T>: Debug, S: Get<u32>,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T, S> Decode for BoundedBTreeSet<T, S>

where T: Decode + Ord, S: Get<u32>,

fn decode<I>(input: &mut I) -> Result<BoundedBTreeSet<T, S>, Error>

where I: Input,

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T, S> DecodeLength for BoundedBTreeSet<T, S>

fn len(self_encoded: &[u8]) -> Result<usize, Error>

Return the number of elements in self_encoded.

impl<T, S> Default for BoundedBTreeSet<T, S>

where T: Ord, S: Get<u32>,

fn default() -> BoundedBTreeSet<T, S>

Returns the “default value” for a type.

impl<T, S> Deref for BoundedBTreeSet<T, S>

where T: Ord,

type Target = BTreeSet<T>

The resulting type after dereferencing.

fn deref(&self) -> &<BoundedBTreeSet<T, S> as Deref>::Target

Dereferences the value.

impl<'de, T, S> Deserialize<'de> for BoundedBTreeSet<T, S>

where S: Get<u32> + Clone, T: Ord + Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<BoundedBTreeSet<T, S>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, S> Encode for BoundedBTreeSet<T, S>

where BTreeSet<T>: Encode, PhantomData<S>: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T, S> From<BoundedBTreeSet<T, S>> for BTreeSet<T>

where T: Ord,

fn from(set: BoundedBTreeSet<T, S>) -> BTreeSet<T>

Converts to this type from the input type.

impl<T, S> Hash for BoundedBTreeSet<T, S>

where T: Hash,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T, S> IntoIterator for &'a BoundedBTreeSet<T, S>

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) -> <&'a BoundedBTreeSet<T, S> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T, S> IntoIterator for BoundedBTreeSet<T, S>

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) -> <BoundedBTreeSet<T, S> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T, S> MaxEncodedLen for BoundedBTreeSet<T, S>

where T: MaxEncodedLen, S: Get<u32>,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<T, S> Ord for BoundedBTreeSet<T, S>

where BTreeSet<T>: Ord, S: Get<u32>,

fn cmp(&self, other: &BoundedBTreeSet<T, S>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T, S> PartialEq<BTreeSet<T>> for BoundedBTreeSet<T, S>

where BTreeSet<T>: PartialEq, S: Get<u32>,

fn eq(&self, other: &BTreeSet<T>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, S1, S2> PartialEq<BoundedBTreeSet<T, S1>> for BoundedBTreeSet<T, S2>

where BTreeSet<T>: PartialEq, S1: Get<u32>, S2: Get<u32>,

fn eq(&self, other: &BoundedBTreeSet<T, S1>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, S> PartialOrd for BoundedBTreeSet<T, S>

where BTreeSet<T>: PartialOrd, S: Get<u32>,

fn partial_cmp(&self, other: &BoundedBTreeSet<T, S>) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

impl<T, S> Serialize for BoundedBTreeSet<T, S>

where T: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, S> StorageDecodeNonDedupLength for BoundedBTreeSet<T, S>

fn decode_non_dedup_len(key: &[u8]) -> Option<usize>

Decode the length of the storage value at key.

impl<T, S> TryFrom<BTreeSet<T>> for BoundedBTreeSet<T, S>

where T: Ord, S: Get<u32>,

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: BTreeSet<T>, ) -> Result<BoundedBTreeSet<T, S>, <BoundedBTreeSet<T, S> as TryFrom<BTreeSet<T>>>::Error>

Performs the conversion.

impl<T, S> TypeInfo for BoundedBTreeSet<T, S>

where BTreeSet<T>: TypeInfo + 'static, PhantomData<S>: TypeInfo + 'static, T: TypeInfo + 'static, S: 'static,

type Identity = BoundedBTreeSet<T, S>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T, S> EncodeLike<BTreeSet<T>> for BoundedBTreeSet<T, S>

where BTreeSet<T>: Encode,

impl<T, S> EncodeLike for BoundedBTreeSet<T, S>

where BTreeSet<T>: Encode, PhantomData<S>: Encode,

impl<T, S> Eq for BoundedBTreeSet<T, S>

where BTreeSet<T>: Eq, S: Get<u32>,