Struct BitVector 

pub struct BitVector { /* private fields */ }

Immutable bitset stored in a refcounted Bytes buffer of LE u64 words.

Supports bitwise combinators (and, or, not, xor) that return new bitvectors. Mutation lives on BitVectorBuilder.

Implementations

impl BitVector

pub fn from_raw_parts(data: Vec<u64>, len: usize) -> Self

Reconstructs from pre-packed raw parts (legacy: Vec<u64> words).

Used by section deserialization that holds words on the heap. Phase 3c will add from_bytes_storage for mmap-backed construction.

pub fn from_bytes_storage(data: Bytes, len: usize) -> Self

Constructs from pre-encoded bytes (Phase 3c entry point).

data must be ceil(len / 64) * 8 bytes of little-endian u64 words. Used by the mmap path so a column can hold a slice of mapped memory without copying.

pub fn from_mmap(data: Bytes, len: usize) -> Result<Self, BitVectorFormatError>

Phase 6a: zero-copy mmap constructor.

Adopts a refcounted Bytes slice (typically produced by Bytes::from_owner(mmap) or a sub-slice thereof) as the backing storage without copying. The on-disk contract is little-endian u64 words, with len total bits stored in ceil(len / 64) * 8 bytes.

Errors

Returns an error if the byte length doesn’t match the expected ceil(len / 64) * 8 for the declared bit count. This guards against truncated or oversized mmap regions.

pub fn new() -> Self

Creates an empty bit vector.

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

Creates a bit vector from a slice of booleans.

Routes through a BitVectorBuilder internally; Phase 3b preserves the original convenience API for callers that already have the bools materialized.

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

Creates a bit vector with all bits set to the same value.

pub fn zeros(len: usize) -> Self

Creates a bit vector with all bits set to false.

pub fn ones(len: usize) -> Self

Creates a bit vector with all bits set to true.

pub fn len(&self) -> usize

Returns the number of bits.

pub fn is_empty(&self) -> bool

Returns whether the bit vector is empty.

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

Gets the bit at the given index.

pub fn word_count(&self) -> usize

Returns the number of u64 words backing this bit vector.

pub fn word_at(&self, idx: usize) -> Option<u64>

Returns the word at idx, or None if out of range.

Reads via from_le_bytes; supports unaligned Bytes slices (e.g., mmap-backed sub-slices in Phase 3c).

pub fn data_bytes(&self) -> &Bytes

Returns the raw byte storage.

Phase 3c serializers use this to write the storage out directly (the on-disk format already matches our LE word layout).

pub fn count_ones(&self) -> usize

Returns the number of bits set to true.

pub fn count_zeros(&self) -> usize

Returns the number of bits set to false.

pub fn to_bools(&self) -> Vec<bool>

Converts back to a Vec<bool>.

Panics

Panics if internal storage is shorter than len() bits — an invariant violation that would indicate a bug in from_bytes_storage caller’s data validation.

pub fn iter(&self) -> impl Iterator<Item = bool> + '_

Returns an iterator over the bits.

Panics

Panics if internal storage is shorter than len() bits.

pub fn ones_iter(&self) -> impl Iterator<Item = usize> + '_

Returns an iterator over indices where bits are true.

Panics

Panics if internal storage is shorter than len() bits.

pub fn zeros_iter(&self) -> impl Iterator<Item = usize> + '_

Returns an iterator over indices where bits are false.

Panics

Panics if internal storage is shorter than len() bits.

pub fn compression_ratio(&self) -> f64

Returns the compression ratio (original bytes / compressed bytes).

pub fn and(&self, other: &Self) -> Self

Performs bitwise AND with another bit vector. The result has the length of the shorter vector.

pub fn or(&self, other: &Self) -> Self

Performs bitwise OR with another bit vector.

pub fn not(&self) -> Self

Performs bitwise NOT.

pub fn xor(&self, other: &Self) -> Self

Performs bitwise XOR with another bit vector.

pub fn to_bytes(&self) -> Result<Vec<u8>>

Serializes to bytes.

Errors

Returns Err if the bit-vector length exceeds u32::MAX.

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

Deserializes from bytes.

Errors

Returns Err if the byte slice is too short or contains invalid data.

Trait Implementations

impl Clone for BitVector

fn clone(&self) -> BitVector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitVector

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

Formats the value using the given formatter.

impl Default for BitVector

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BitVector

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromIterator<bool> for BitVector

fn from_iter<T: IntoIterator<Item = bool>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for BitVector

fn eq(&self, other: &Self) -> 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 Serialize for BitVector

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for BitVector