Struct PackedBitVector

pub struct PackedBitVector { /* private fields */ }

A vector of packed bits. This type can be constructed by calling PackedBitVector::new.

Implementations

impl PackedBitVector

pub fn new( vector: Vec<u8>, padding: impl Into<Option<u8>>, ) -> Result<PackedBitVector, Error>

Construct a new PackedBitVector. Each u8 value in the provided vector represents 8 single-bit elements in little-endian format. For example, the following vector:

let packed_bits = vec![238, 224];
let vector = PackedBitVector::new(packed_bits, 0)?;

represents a 16-bit vector containing the following values:

[1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0, 0, 0, 0, 0]

Padding can optionally be specified to ignore a number of least-significant bits in the final byte. For example, the vector in the previous example with a padding of 4 would represent a 12-bit vector containing the following values:

[1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 0]

Padding must be within 0-7 inclusive. Padding must be 0 or unspecified if the provided vector is empty.

Trait Implementations

impl Clone for PackedBitVector

fn clone(&self) -> PackedBitVector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackedBitVector

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

Formats the value using the given formatter.

impl PartialEq for PackedBitVector

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