Struct BitSet

pub struct BitSet<V: BitValue> { /* private fields */ }

A set of V, stored as a bit set.

Implementations

impl<V: BitValue> BitSet<V>

pub const fn new() -> Self

Creates an empty bit set that doesn’t contain any values.

pub fn words(&self) -> &[Word]

Returns a reference to the underlying Words making up this BitSet.

Note that the Word type varies in size and endianness between platforms, so if you want to use this for cross-platform serialization, make sure to convert the data to something portable first.

The number of Words that make up any given BitSet can also vary between platforms, and is generally only guaranteed to be large enough to store <V as BitValue>::MAX, but may be arbitrarily larger.

pub fn words_mut(&mut self) -> &mut [Word]

Returns a mutable reference to the underlying Words making up this BitSet.

You should not set any bits to 1 whose indices are larger than <V as BitValue>::MAX. Doing so might cause the BitSet to behave incorrectly.

Note that the Word type varies in size between platforms.

pub fn len(&self) -> usize

Returns the number of elements in this BitSet (the number of set bits).

pub fn is_empty(&self) -> bool

Returns whether this BitSet is empty (contains no set bits).

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

Returns whether self contains value.

pub fn insert(&mut self, value: V) -> bool

Inserts value into self, setting the appropriate bit.

Returns true if value was newly inserted, or false if it was already present.

Panics

Panics if value is larger than <V as BitValue>::MAX.

pub fn remove(&mut self, value: V) -> bool

Removes value from the set.

Returns true if it was present and has been removed, or false if it was not present.

pub fn iter(&self) -> Iter<'_, V>

Returns an iterator over all values in self.

Trait Implementations

impl<V: BitValue> Clone for BitSet<V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: BitValue + Debug> Debug for BitSet<V>

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

Formats the value using the given formatter.

impl<V: BitValue> Default for BitSet<V>

fn default() -> Self

Returns the “default value” for a type.

impl<V: BitValue> Extend<V> for BitSet<V>

fn extend<T: IntoIterator<Item = V>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

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

impl<V: BitValue> FromIterator<V> for BitSet<V>

fn from_iter<T: IntoIterator<Item = V>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a, V: BitValue> IntoIterator for &'a BitSet<V>

type Item = V

The type of the elements being iterated over.

type IntoIter = Iter<'a, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<V: BitValue> IntoIterator for BitSet<V>

type Item = V

The type of the elements being iterated over.

type IntoIter = IntoIter<V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<V: BitValue> PartialEq for BitSet<V>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<V: BitValue> Copy for BitSet<V>

impl<V: BitValue> Eq for BitSet<V>