Struct bitvec_rs::BitVec

source ·

pub struct BitVec { /* private fields */ }

Expand description

Bit vector with guaranteed [u8] LSB 0 representation and safe mutable access to this slice. Slices into the bit vector are guaranteed to have the unused bits on the last byte set to 0.

Implementations§

source §

impl BitVec

source

pub const fn new() -> Self

Constructs an empty BitVec.

source

pub fn with_capacity(capacity: usize) -> Self

Constructs an empty BitVec with the given capacity.

The bit vector will be able to hold at least capacity bits without reallocating. If capacity is 0, the bit vector will not allocate.

source

pub fn from_bytes(bytes: &[u8]) -> Self

Constructs a BitVec from bytes.

source

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

Constructs a BitVec from bools.

source

pub fn from_elem(len: usize, value: bool) -> Self

Constructs a BitVec from a repeating bit value.

source §

impl BitVec

source

pub fn as_bytes(&self) -> &[u8]

Returns a byte slice view of the data.

source

pub fn with_bytes_mut<U, F: FnOnce(&mut [u8]) -> U>(&mut self, f: F) -> U

Invokes the given function on a mut byte slice view of the data. After f completes, the trailing unused bits of the last byte are automatically set to 0.

source

pub fn into_bytes(self) -> Vec<u8>

Consumes the self and returns the underlying Vec<u8> of length ceil(self.len()/8). The values of the bits in the last byte of Vec<u8> beyond the length of the BitVec are 0.

source

pub fn len(&self) -> usize

Returns the length of the bit vector.

source

pub fn is_empty(&self) -> bool

Returns whether the vector is empty.

source

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

Gets the bit at the given index.

source

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

Sets the bit at the given index. Panics if index exceeds length.

source

pub fn swap(&mut self, i: usize, j: usize)

Swaps two elements in the BitVec.

source

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

Gets the bit at the given index without bounds checking.

source

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

Sets the bit at the given index without bounds checking.

source

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

Pushes a boolean to the end of the BitVec.

source

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

Pops a boolean from the end of the BitVec.

source

pub fn clear(&mut self)

Clears the BitVec, removing all values.

source

pub fn capacity(&self) -> usize

Returns the number of booleans that the bitvec can hold without reallocating.

source

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more booleans to be inserted in the given BitVec. The collection may reserve more space to avoid frequent reallocations.

source

pub fn truncate(&mut self, len: usize)

Shorten a vector, dropping excess elements.

If len is greater than the vector’s current length, this has no effect.

source

pub fn resize(&mut self, new_len: usize, value: bool)

Reserves capacity for at least additional more booleans to be inserted in the given BitVec. The collection may reserve more space to avoid frequent reallocations.

source