Struct BitPackedInts 

pub struct BitPackedInts { /* private fields */ }

Stores integers using only as many bits as the largest value needs.

Pass your values to pack() and we’ll figure out the optimal bit width automatically. Random access via get() is O(1).

Implementations

impl BitPackedInts

pub fn from_raw_parts(data: Vec<u64>, bits_per_value: u8, count: usize) -> Self

Reconstructs from pre-packed raw parts.

Used by section deserialization. The caller is responsible for ensuring the data is consistent (correct word count for the given bits and count).

pub fn pack(values: &[u64]) -> Self

Packs a slice of u64 values using the minimum bits needed.

pub fn pack_with_bits(values: &[u64], bits_per_value: u8) -> Self

Packs values using a specified bit width.

Panics

Panics if any value doesn’t fit in the specified bit width.

pub fn unpack(&self) -> Vec<u64>

Unpacks all values back to u64.

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

Gets a single value at the given index.

pub fn len(&self) -> usize

Returns the number of values.

pub fn is_empty(&self) -> bool

Returns whether the encoding is empty.

pub fn bits_per_value(&self) -> u8

Returns the number of bits per value.

pub fn data(&self) -> &[u64]

Returns the raw packed data.

pub fn compression_ratio(&self) -> f64

Returns the compression ratio compared to storing full u64s.

pub fn bits_needed(value: u64) -> u8

Returns the number of bits needed to represent a value.

The result is always in 1..=64.

Panics

Cannot panic: the result of 64 - leading_zeros() is always in 1..=64, which fits u8.

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

Serializes to bytes.

Errors

Returns Err if the value count 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 BitPackedInts

fn clone(&self) -> BitPackedInts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitPackedInts

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

Formats the value using the given formatter.