Crate jerky 

Succinct data structures in Rust

Jerky is a collection of succinct data structures, powerful tools to store a variety of data structures in compressed space and quickly perform operations on the compressed data.

Design policy

Thus far, many succinct data structures and their implementation techniques have been developed for a wide range of applications. To handle them in a single crate, we set up several design policies:

• Maintain interface consistency: Jerky will adhere to a unified interface, facilitating the integration and replacement of data structures.

• Preserve identity: Rather than offering every possible succinct data structure, Jerky will focus on providing only those that hold a competitive advantage over others.

• Ensure safety: To avoid potential risks, Jerky will refrain from using unsafe instructions typically reserved for extremely low-level programming.

• Remain Rust-centric: Jerky will consistently utilize Pure Rust in its implementation.

Data structures

The data structures provided in this crate are categorized as follows:

• Integer vectors
• Bit vectors
• Character sequences

The descriptions for each category are available in the corresponding module.

Throughout this document, we write $\log_2$ with $\lg$.

Serialization

The previous copying based serialization infrastructure has been removed and will be replaced with zero‑copy utilities in the future.

Limitation

This library is designed to run on 64-bit machines.

Re-exports

pub use bit_vector::BitVector;

pub use bit_vector::BitVectorData;

pub use bit_vector::BitVectorIndex;

pub use bit_vector::NoIndex;

pub use data::IntVectorData;

pub use error::Error;

pub use error::Result;

pub use serialization::Serializable;

Modules

bit_vector

Top module for bit vectors.

broadword

Broadword tools.

char_sequences

Top module for character sequences.

data

Raw storage types for integer sequences.

error

Common error types used throughout the crate.

int_vectors

Top module for integer vectors.

serialization

Zero-copy serialization utilities.

utils

Utilities in Sucds.