splinter-rs 0.12.2

A compressed bitmap format optimized for small, sparse sets of u32s with zero-copy querying.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//! Splinter is a compressed bitmap format similar to [Roaring
//! Bitmaps](https://roaringbitmap.org/), optimized specifically for small,
//! sparse sets of 32-bit unsigned integers (`u32`).
//!
//! ## Key Features:
//!
//! - **Tree-based Encoding**: Splinter encodes `u32` values into a 256-way tree
//!   structure by decomposing integers into big-endian component bytes. Nodes
//!   throughout the tree (including the root) are optimized into four different
//!   storage classes: tree, vec, bitmap, run.
//! - **Zero-copy Access**: Designed for efficient querying without
//!   deserialization, the `SplinterRef` type allows direct, zero-copy reads from
//!   any type implementing `Deref<Target = [u8]>`.

pub mod codec;
pub mod cow;
pub mod level;
pub mod splinter;
pub mod splinter_ops;
pub mod splinter_ref;
pub mod splinter_ref_ops;
pub mod traits;

#[doc(hidden)]
pub mod count;

mod never;
mod partition;
mod partition_kind;
mod partition_ops;
mod segment;
mod util;

#[doc(inline)]
pub use cow::CowSplinter;
#[doc(inline)]
pub use splinter::Splinter;
#[doc(inline)]
pub use splinter_ref::SplinterRef;

#[doc(inline)]
pub use crate::{
    codec::{DecodeErr, Encodable},
    traits::{Cut, Optimizable, PartitionRead, PartitionWrite},
};

#[cfg(any(test, feature = "testutil"))]
pub mod testutil;