hexane 0.2.1

A columnar compression library used by automerge
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//! Hexane is a columnar compression library implementing the encoding described in the
//! [Automerge Binary Format](https://automerge.org/automerge-binary-format-spec/).
//!
//! Data is stored in [`ColumnData<C>`] where the cursor type `C` selects the encoding
//! (`RLE<T>`, delta, boolean, or raw). Values are batched into [`Slab`]s — `Arc`-wrapped byte
//! buffers — held in a [`SpanTree`] B-tree for O(log n) positional seek, insert, and splice.
//!
//! # Cursor Types
//!
//! | Type            | Item    | Encoding                        |
//! |-----------------|---------|---------------------------------|
//! | [`UIntCursor`]  | `u64`   | RLE + unsigned LEB128           |
//! | [`IntCursor`]   | `i64`   | RLE + signed LEB128             |
//! | [`StrCursor`]   | `str`   | RLE + length-prefixed UTF-8     |
//! | [`ByteCursor`]  | `[u8]`  | RLE + length-prefixed bytes     |
//! | [`BooleanCursor`]| `bool` | Boolean run-length encoding     |
//! | [`DeltaCursor`] | `i64`   | Delta-encoded integers          |
//! | [`RawCursor`]   | `[u8]`  | Uncompressed raw bytes          |
//!
//! # Quick Example
//!
//! ```rust
//! use hexane::{ColumnData, UIntCursor};
//!
//! let mut col: ColumnData<UIntCursor> = ColumnData::new();
//! col.splice(0, 0, [1u64, 2, 3, 4, 5]);
//! assert_eq!(col.to_vec(), vec![Some(1), Some(2), Some(3), Some(4), Some(5)]);
//!
//! let bytes = col.save();
//! let col2: ColumnData<UIntCursor> = ColumnData::load(&bytes).unwrap();
//! assert_eq!(col.to_vec(), col2.to_vec());
//! ```
//!
//! See the [README](https://github.com/automerge/automerge/tree/main/rust/hexane) for
//! comprehensive usage documentation.

#[doc(hidden)]
#[macro_export]
macro_rules! log {
     ( $( $t:tt )* ) => {
          {
            use $crate::__log;
            __log!( $( $t )* );
          }
     }
 }

#[cfg(all(feature = "wasm", target_family = "wasm"))]
#[doc(hidden)]
#[macro_export]
macro_rules! __log {
     ( $( $t:tt )* ) => {
         web_sys::console::log_1(&format!( $( $t )* ).into());
     }
 }

#[cfg(not(all(feature = "wasm", target_family = "wasm")))]
#[doc(hidden)]
#[macro_export]
macro_rules! __log {
     ( $( $t:tt )* ) => {
         println!( $( $t )* );
     }
 }

pub(crate) mod aggregate;
pub(crate) mod boolean;
pub(crate) mod columndata;
pub(crate) mod cursor;
pub(crate) mod delta;
pub(crate) mod encoder;
pub(crate) mod leb128;
pub(crate) mod pack;
pub(crate) mod raw;
pub(crate) mod rle;
pub(crate) mod slab;

#[cfg(test)]
pub mod test;

pub use aggregate::{Acc, Agg};
pub use boolean::BooleanCursor;
pub use columndata::{
    ColAccIter, ColGroupItem, ColGroupIter, ColumnData, ColumnDataIter, ColumnDataIterState,
};
pub use cursor::{ColumnCursor, CursorIter, HasAcc, HasMinMax, HasPos, Run, RunIter, SpliceDel};
pub use delta::DeltaCursor;
pub use encoder::{Encoder, EncoderState};
pub use leb128::{lebsize, ulebsize};
pub use pack::{MaybePackable, PackError, Packable};
pub use raw::{RawCursor, RawReader, ReadRawError};
pub use rle::{ByteCursor, IntCursor, RleCursor, StrCursor, UIntCursor};
pub use slab::{tree, Slab, SlabTree, SlabWeight, SlabWriter, SpanTree, SpanWeight, WriteOp};

pub(crate) use std::borrow::Cow;