Skip to main content

lamfold_romfs/
lib.rs

1//! # lamfold-romfs — the romfs frontend of the lamfold read-only media stack.
2//!
3//! Clean-room reader for Linux romfs (the `-rom1fs-` format): the minimal,
4//! uncompressed read-only filesystem used in tiny embedded and early-boot
5//! images. It is the floor of the flock — no compression, no block index, just
6//! a big-endian chain of 16-byte-aligned file headers.
7//!
8//! Reads over a lamfold [`lamfold::BlockSource`] and implements
9//! [`lamfold::FoldFrontend`]; composes through `dispatch_fs_over_source` like
10//! every other frontend.
11//!
12//! Scope: the full romfs read path — header, the directory next-chain, regular
13//! files, and symlinks (`read_link`). romfs has no compression, owners, or
14//! timestamps to surface.
15//!
16//! Derived only from the public format (kernel
17//! `Documentation/filesystems/romfs.rst`); the GPL-2 `fs/romfs` driver is fenced
18//! off. Note: `neotron-romfs` is a *different, incompatible* format and a GPL-3
19//! sibling — deliberately not consulted.
20
21#![cfg_attr(not(any(test, feature = "std")), no_std)]
22#![forbid(unsafe_code)]
23
24extern crate alloc;
25
26mod romfs;
27
28pub use romfs::Romfs;