Struct RunLengthEncoding 

pub struct RunLengthEncoding { /* private fields */ }

Run-length encoded data for u64 values.

Stores sequences of (value, count) pairs. Achieves excellent compression when data has long runs of repeated values.

Implementations

impl RunLengthEncoding

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

Encodes a slice of u64 values using run-length encoding.

Example

let values = vec![1, 1, 1, 2, 2, 3];
let encoded = RunLengthEncoding::encode(&values);
// Results in 3 runs: (1, 3), (2, 2), (3, 1)

pub fn from_runs(runs: Vec<Run<u64>>) -> Self

Creates a run-length encoding from pre-built runs.

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

Decodes back to the original values.

pub fn run_count(&self) -> usize

Returns the number of runs.

pub fn total_count(&self) -> usize

Returns the total number of values represented.

pub fn runs(&self) -> &[Run<u64>]

Returns the runs.

pub fn is_empty(&self) -> bool

Returns true if there are no values.

pub fn compression_ratio(&self) -> f64

Returns the compression ratio (original size / encoded size).

Values > 1.0 indicate compression, < 1.0 indicate expansion.

pub fn is_beneficial(&self) -> bool

Returns true if run-length encoding is beneficial for this data.

Returns true when compression ratio > 1.0 (actual compression achieved).

pub fn encoded_size(&self) -> usize

Returns the memory size in bytes of the encoded representation.

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

Serializes the run-length encoding to bytes.

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

Deserializes run-length encoding from bytes.

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

Gets the value at a specific index without full decompression.

Returns None if index is out of bounds.

pub fn iter(&self) -> RunLengthIterator<'_>

Returns an iterator over the decoded values.

Trait Implementations

impl Clone for RunLengthEncoding

fn clone(&self) -> RunLengthEncoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunLengthEncoding

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a RunLengthEncoding

type Item = u64

The type of the elements being iterated over.

type IntoIter = RunLengthIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.