Struct terminus_store::structure::bitarray::BitArray

pub struct BitArray { /* fields omitted */ }

A thread-safe, reference-counted, compressed bit sequence.

A BitArray is a wrapper around a Bytes that provides a view of the underlying data as a compressed sequence of bits.

As with other types in structures, a BitArray is created from an existing buffer, rather than constructed from parts. The buffer may be read from a file or other source and may be very large. A BitArray preserves the buffer to save memory but provides a simple abstraction of being a vector of bools.

Implementations

impl BitArray

pub fn from_bits(buf: Bytes) -> Result<BitArray, BitArrayError>

Construct a BitArray by parsing a Bytes buffer.

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

Returns a reference to the buffer slice.

pub fn len(&self) -> usize

Returns the number of usable bits in the bit array.

pub fn is_empty(&self) -> bool

Returns true if there are no usable bits.

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

Reads the data buffer and returns the logical value of the bit at the bit index.

Panics if index is >= the length of the bit array.

Trait Implementations

impl Clone for BitArray

fn clone(&self) -> BitArray

Returns a copy of the value.

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

Performs copy-assignment from source.