coordinode-lsm-tree 5.4.0

Embedded LSM-tree storage engine: BuRR filters, zstd dictionary compression, MVCC, range tombstones, merge operators, K/V separation, AES-256-GCM at rest.
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

// SPDX-License-Identifier: MIT OR Apache-2.0
// Copyright (c) 2025-present, fjall-rs
//
// Vendored from `sfa` v1.0.0 (https://github.com/fjall-rs/sfa) at
// upstream main 4d9a9aa2 (2026-01-14). Inlined into this crate so
// the public `sfa` crates.io dependency can be dropped — upstream
// does not accept PRs from this fork and we want local control
// over the format used by the blob-file (vlog) layer.
//
// LICENSE-MIT and LICENSE-APACHE preserved alongside this file.
// Future upstream sync, if any, is a manual diff across the tree.

//! Sectioned-archive format inherited from the upstream `sfa` crate.
//!
//! Used by the blob-file (vlog) layer as its on-disk wire format
//! for keys + values. The Blocks-based manifest layer (V5-2 #297)
//! does NOT use this module; manifest framing lives in
//! `crate::manifest_blocks`.
//!
//! Internal-use API: the module is exported via
//! `#[doc(hidden)] pub mod sfa` from `crate::lib.rs` so integration
//! tests (`tests/inspect.rs`, `tests/meta_mirror.rs`, etc.) can
//! reach the inspection helpers, but it is NOT part of the crate's
//! stable surface. The `pub use` re-exports below match this
//! posture — technically reachable as `lsm_tree::sfa::*`, but
//! doc-hidden and subject to change without notice. Production
//! consumers reach these types through the blob-file (vlog) layer,
//! not through `lsm_tree::sfa` directly.

// Vendored sfa: most lints triggered by upstream's coding style
// have been driven to zero by the per-site fixes (typed errors
// instead of expect, fully-documented exports, bounded
// allocations); the module-level suppression list that previously
// shielded those sites is now empty. Per-line `#[expect(...)]`
// attributes remain on the few sites that genuinely still need
// them — `#[expect]` will fire if any of those goes stale, which
// is the migration signal we want.

mod checksum;
mod checksum_writer;
mod error;
// The archive `Reader` opens a file by path (std::fs + BufReader), so it is
// genuinely std-bound; the wire codec (toc / trailer / writer over generic
// Read/Write) is no_std-capable and stays ungated.
mod reader;
mod toc;
mod trailer;
mod writer;

// `pub` (not `pub(crate)`) so the vendored `Reader::from_reader`,
// `Writer::finish`, `Writer::into_inner`, `TrailerReader::from_reader`
// signatures don't trip the `private_interfaces` lint: their pub fns
// live inside `#[doc(hidden)] pub mod sfa` which is reachable from
// outside the crate, so any type in their signatures must be at least
// as visible as the fn. The alias stays doc-hidden via the parent
// module's `#[doc(hidden)]`.
pub type Result<T> = core::result::Result<T, Error>;

pub use checksum::Checksum;
pub use error::Error;
pub use reader::Reader;
pub use toc::{Toc, entry::TocEntry};
pub use writer::Writer;