Struct BitVec

pub struct BitVec<W: BitWord> { /* private fields */ }

A growable, heap-allocated bit vector.

BitVec provides a contiguous growable array of bits, similar to Vec<bool>, but much more efficient. The underlying storage is a raw pointer to a bitset, and the length and capacity are tracked in bits.

Implementations

impl<W: BitWord> BitVec<W>

pub fn new_uninit(bit_len: usize) -> Self

Creates a new, uninitialized bit vector with the given number of bits.

Arguments

• bit_len - The number of bits to allocate.

Safety

The bits are uninitialized and may contain garbage values.

pub fn new(bit_len: usize) -> Self

Creates a new, zero-initialized bit vector with the given number of bits.

Arguments

• bit_len - The number of bits to allocate.

pub fn resize(&mut self, new_bit_len: usize)

Resizes the bit vector to the new length in bits.

If the new length is greater than the current length, new bits are zero-initialized. If the new length is less, excess bits are dropped.

Arguments

• new_bit_len - The new length in bits.

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

Returns an iterator over the bits of the vector.

pub fn as_view(&self) -> BitView<'_, W>

Returns a read-only view of the bit vector.

pub fn as_view_mut(&self) -> BitViewMut<'_, W>

Returns a mutable view of the bit vector.

pub fn slice(&self, offset: usize, len: usize) -> BitSpan<'_, W>

Returns a slice of the bit vector as a BitSpan.

Arguments

• offset - The starting bit index.
• len - The number of bits in the slice.

pub fn slice_mut(&self, offset: usize, len: usize) -> BitSpanMut<'_, W>

Trait Implementations

impl<W: BitWord> BitRead for BitVec<W>

type Iter<'b> = Iter<'b, W> where Self: 'b

fn len(&self) -> usize

Returns the number of bits in the bitset.

fn is_empty(&self) -> bool

Returns true if the bitset contains no set bits.

fn test(&self, idx: usize) -> bool

Returns true if the bit at position idx is set.

fn count_ones(&self) -> usize

Returns the number of set bits.

fn all(&self) -> bool

Returns true if all bits are set.

fn any(&self) -> bool

Returns true if any bit is set.

fn iter(&self) -> Self::Iter<'_>

fn none(&self) -> bool

impl<W: BitWord> BitWrite for BitVec<W>

fn set(&mut self, idx: usize)

Sets the bit at position idx.

fn reset(&mut self, idx: usize)

Clears the bit at position idx.

fn flip(&mut self, idx: usize)

flit the bit at position idx.

fn test_and_set(&mut self, idx: usize) -> bool

Sets the bit at position idx and returns the previous value.

fn fill(&mut self)

Sets all bits to 1.

fn clear(&mut self)

Clears all bits to 0.

fn take(&mut self, idx: usize) -> bool

return and clear bit at idx.

fn replace(&mut self, idx: usize, value: bool) -> bool

set bit to value, return old.

impl<T: Debug + BitWord> Debug for BitVec<T>

Implements the Debug trait for BitFixed.

This provides a human-readable representation of the bitset for debugging.

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

Formats the bitset for debugging.

impl<W: BitWord> Drop for BitVec<W>

fn drop(&mut self)

Executes the destructor for this type.