Struct cbitset::BitSet

#[repr(transparent)]
pub struct BitSet<T: BitArray> { /* fields omitted */ }

The bit set itself

This wrapper is #![repr(transparent)] and guaranteed to have the same memory representation as the inner bit array

Panics

All non-try functions taking a bit parameter panics if the bit is bigger than the capacity of the set. For non-panicking versions, use try_.

Methods

impl<T: BitArray> BitSet<T>

pub fn new() -> Self

Create an empty instance

pub fn from_ref(inner: &mut T) -> &mut Self

Transmutes a reference to a borrowed bit array to a borrowed BitSet with the same lifetime

pub fn into_inner(self) -> T

Return the inner integer array

pub fn capacity() -> usize

Returns the capacity of the set, in other words how many bits it can hold. This function may very well overflow if the size or length is too big, but if you're making that big allocations you probably got bigger things to worry about.

pub fn insert(&mut self, bit: usize)

Enable the value bit in the set. If bit is already enabled this is a no-op.

pub fn try_insert(&mut self, bit: usize) -> bool

Like insert, but does not panic if the bit is too large. See the struct level documentation for notes on panicking.

pub fn remove(&mut self, bit: usize)

Disable the value bit in the set. If bit is already disabled this is a no-op.

pub fn try_remove(&mut self, bit: usize) -> bool

Like remove, but does not panic if the bit is too large. See the struct level documentation for notes on panicking.

pub fn contains(&self, bit: usize) -> bool

Returns true if the bit bit is enabled. If the bit is out of bounds this silently returns false.

pub fn try_contains(&self, bit: usize) -> Option<bool>

Returns true if the bit bit is enabled.

pub fn count_ones(&self) -> u32

Returns the total number of enabled bits

pub fn count_zeros(&self) -> u32

Returns the total number of disabled bits

pub fn clear(&mut self)

Disable all bits in a range.

pub fn fill<R: RangeBounds<usize>>(&mut self, range: R, on: bool)

Set all bits in a range. fill(.., false) is effectively the same as clear().

Panics

Panics if the start or end bounds are more than the capacity.

Trait Implementations

impl<T: Copy + BitArray> Copy for BitSet<T>

impl<T: BitArray> From<T> for BitSet<T>

fn from(inner: T) -> Self

Performs the conversion.

impl<T: Clone + BitArray> Clone for BitSet<T>

fn clone(&self) -> BitSet<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default + BitArray> Default for BitSet<T>

fn default() -> BitSet<T>

Returns the "default value" for a type.