lamfold 0.1.1

no_std read-only media filesystem stack — substrate core (codec registry, immutable-block cache, bounded zero-copy parse, frontend trait, integrity-verification seam)
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

//! # lamfold — read-only media filesystem stack (substrate core)
//!
//! `lamfold` is an **immutable-media filesystem stack**: a shared `no_std`
//! substrate under thin, clean-room format frontends (the *flock*). This crate
//! is the substrate (L2) — the shared engine every frontend sits on:
//!
//! * `codec` — the decompression-codec registry (deflate/lz4 wired; zstd/xz/lzo
//!   declared), one decoder shared across all compressed formats ([`decode`],
//!   [`lz4_block_with_dict`]).
//! * [`BlockCache`] — an immutable decompressed-block LRU (read-only ⇒ no
//!   invalidation).
//! * `read_cap` — bounded-allocation hardening (no OOM on a hostile size;
//!   [`checked_full_read_len`], [`checked_block_len`]).
//! * [`FoldFrontend`] — the trait the flock implements; [`Verifier`] — the
//!   shepherd (integrity-verification seam).
//! * [`BlockSource`] — the byte source a frontend reads over (LamBoot adapts its
//!   own `BlockSource` to this at integration).
//!
//! Frontends (`lamfold-iso`, `-udf`, `-squash`, `-erofs`, …) live in their own
//! crates and depend on this one. See `the lamfold design spec`.
//!
//! Read-only by construction; `#![forbid(unsafe_code)]` in the substrate —
//! `zerocopy` removes the transmute class, so the parse layer needs no `unsafe`.

#![cfg_attr(not(any(test, feature = "std")), no_std)]
#![forbid(unsafe_code)]

extern crate alloc;

mod cache;
mod codec;
mod error;
mod frontend;
mod path;
mod read_cap;
mod source;
mod verify;
#[cfg(feature = "verify")]
mod verity;

pub use cache::BlockCache;
pub use codec::{decode, lz4_block_with_dict, microlzma_block_decode, Codec};
pub use error::{FoldError, Result};
pub use frontend::{DirEntry, FileKind, FoldFrontend, Metadata, NodeId, SubstrateCtx};
pub use path::{metadata_path, read_dir_path, read_path, resolve, MAX_SYMLINKS};
pub use read_cap::{
    checked_block_len, checked_full_read_len, MAX_BOOT_FILE_BYTES, MAX_DECOMPRESSED_BLOCK_BYTES,
};
pub use source::{BlockSource, SliceSource};
pub use verify::{NoVerifier, Verifier};
#[cfg(feature = "verify")]
pub use verity::{fsverity_digest_sha256, MerkleVerifier, Sha256Digest, DEFAULT_BLOCK_LOG};