tessarikv-format 0.1.0

On-disk formats of TessariKV: log records and table blocks
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

//! On-disk formats of TessariKV: log records and table blocks.
//!
//! Every format here carries a version and a checksum, and every decoder treats its input as
//! untrusted: a malformed input is an error, never a panic or an unbounded allocation.

// Production code is held to the workspace lints; a test states its own expectations.
#![cfg_attr(
    test,
    allow(
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::as_conversions,
        clippy::arithmetic_side_effects,
        clippy::panic
    )
)]

mod batch;
mod error;
mod log;
mod manifest;
mod seal;
mod table;
mod varint;

pub use batch::{BatchEntry, WriteBatch};
pub use error::{Error, Result};
pub use log::{
    EndKind, FRAME_HEADER_BYTES, FrameReader, LogEnd, LogRead, concat_checksum, encode_frame,
    frame_bytes, frame_header, payload_checksum,
};
pub use manifest::{KeyspaceRecord, ManifestEdit, TableMeta, TableRef, peek_store_format};
pub use seal::{
    Cipher, FileKind, FileSealer, HEADER_BYTES as SEAL_HEADER_BYTES, ROOT_KEY_BYTES, RootKey,
    SealHeader, TAG_BYTES as SEAL_TAG_BYTES,
};
pub use table::block::{Block, BlockBuilder, BlockIter, Compare};
pub use table::filter::{BloomBuilder, BloomFilter, hash as key_hash};
pub use table::{
    BlockHandle, BlockSource, Compression, FOOTER_BYTES, OpenError, Table, TableBuilder, TableIter,
    TableOptions, unseal_block,
};