Struct BitVec

pub struct BitVec { /* private fields */ }

Represents a vector of bits.

Stores bits using u8 blocks for efficient storage.

Implementations

impl BitVec

pub fn new() -> Self

Creates a new, empty BitVec.

pub fn with_capacity(size: usize) -> Self

Creates a new BitVec with the specified capacity in bits.

pub fn zeroes(size: usize) -> Self

Creates a new BitVec with size bits, all initialized to zero.

pub fn ones(size: usize) -> Self

Creates a new BitVec with size bits, all initialized to one.

pub fn from_bools(bools: &[bool]) -> Self

Creates a new BitVec from a slice of booleans.

pub fn len(&self) -> usize

Returns the number of bits in the vector.

pub fn is_empty(&self) -> bool

Returns true if the vector contains no bits.

pub fn push(&mut self, value: bool)

Appends a bit to the end of the vector.

pub fn pop(&mut self) -> Option<bool>

Removes the last bit from the vector and returns it.

Returns None if the vector is empty.

pub fn get(&self, index: usize) -> Option<bool>

Gets the value of the bit at index (true if 1, false if 0).

Returns None if the index is out of bounds.

pub unsafe fn get_unchecked(&self, index: usize) -> bool

Gets the value of the bit at the specified index without bounds checking.

Safety

Caller must ensure index is less than the length of the BitVec.

pub fn set(&mut self, index: usize)

Sets the bit at index to 1.

Panics

Panics if index is out of bounds.

pub fn clear(&mut self, index: usize)

Sets the bit at index to 0.

Panics

Panics if index is out of bounds.

pub fn toggle(&mut self, index: usize)

Flips the bit at index.

Panics

Panics if index is out of bounds.

pub fn set_to(&mut self, index: usize, value: bool)

Sets the bit at index to the specified value.

Panics

Panics if index is out of bounds.

pub fn clear_all(&mut self)

Sets all bits to 0.

pub fn set_all(&mut self)

Sets all bits to 1.

pub fn count_ones(&self) -> usize

Returns the number of bits set to 1.

pub fn count_zeros(&self) -> usize

Returns the number of bits set to 0.

pub fn and(&mut self, other: &BitVec)

Performs a bitwise AND with another BitVec.

Panics

Panics if the lengths don’t match.

pub fn or(&mut self, other: &BitVec)

Performs a bitwise OR with another BitVec.

Panics

Panics if the lengths don’t match.

pub fn xor(&mut self, other: &BitVec)

Performs a bitwise XOR with another BitVec.

Panics

Panics if the lengths don’t match.

pub fn invert(&mut self)

Flips all bits (1s become 0s and vice versa).

pub fn iter(&self) -> BitIterator<'_>

Creates an iterator over the bits.

Trait Implementations

impl BitAnd for &BitVec

type Output = BitVec

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for &BitVec

type Output = BitVec

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitXor for &BitVec

type Output = BitVec

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl Clone for BitVec

fn clone(&self) -> BitVec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitVec

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

Formats the value using the given formatter.

impl Default for BitVec

fn default() -> Self

Returns the “default value” for a type.

impl EncodeSize for BitVec

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

impl From<&[bool]> for BitVec

fn from(s: &[bool]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<&[bool; N]> for BitVec

fn from(arr: &[bool; N]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[bool; N]> for BitVec

fn from(arr: [bool; N]) -> Self

Converts to this type from the input type.

impl From<BitVec> for Vec<bool>

fn from(bv: BitVec) -> Self

Converts to this type from the input type.

impl From<Vec<bool>> for BitVec

fn from(v: Vec<bool>) -> Self

Converts to this type from the input type.

impl Index<usize> for BitVec

fn index(&self, index: usize) -> &Self::Output

Allows accessing bits using the [] operator.

Panics if out of bounds.

type Output = bool

The returned type after indexing.

impl PartialEq for BitVec

fn eq(&self, other: &BitVec) -> 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 Read for BitVec

type Cfg = RangeCfg

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings.

fn read_cfg(buf: &mut impl Buf, range: &Self::Cfg) -> Result<Self, CodecError>

Reads a value from the buffer using the provided configuration cfg.

impl Write for BitVec

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

impl Eq for BitVec

impl StructuralPartialEq for BitVec