Skip to main content

hexz_core/
lib.rs

1//! Core snapshot engine: format, algorithms, cache, and read API.
2//!
3//! `hexz-core` is the minimal, dependency-light foundation for reading Hexz
4//! snapshots. It has no network deps, no async runtime, and no write-path
5//! parallelism. Those concerns live in `hexz-store` and `hexz-ops`.
6//!
7//! # Modules
8//!
9//! - **[`format`]**: On-disk binary structures (header, index, magic, version)
10//! - **[`algo`]**: Compression, encryption, hashing, deduplication traits + impls
11//! - **[`cache`]**: Sharded LRU cache for decompressed blocks and index pages
12//! - **[`store`]**: [`StorageBackend`](store::StorageBackend) trait (implementations in `hexz-store`)
13//! - **[`api`]**: [`File`] — the public read API
14
15pub mod algo;
16pub mod api;
17pub mod cache;
18pub mod format;
19pub mod store;
20
21pub use api::file::{File, SnapshotStream};