Skip to main content

Crate store_io_format

Crate store_io_format 

Source
Expand description

§store-io-format

The on-disk formats of store-io: the CRC-32C checksum, the A/B slot header that every piece of store-io metadata is written with, and the codecs for the payloads those slots carry.

Everything here is pure: no I/O, no allocation, no global state. Every decoder treats its input as hostile and checks every bound before reading; tests flip every bit and tear every byte boundary of a slot, and fuzz targets are planned. The byte-level specification is docs/FORMAT.md in the repository.

Modules§

codec
Little-endian, bounds-checked byte access.
crc32c
CRC-32C (Castagnoli), the checksum of every store-io header.
fill
The keyed fill pattern used to provision regions on thin, virtual, deduplicating, compressing or zero-detecting storage stacks.
footprint
A region’s footprint in container format 2 (spec §9 step 3): the rules between a table entry, its region header and the container that decide whether the region is usable, and the byte ranges it then occupies.
judge
The format-2 tear judgement (docs/FORMAT.md): given both slots of the volume record and of every table page, decide each pair’s standing, which failed copy (if any) is the one metadata write a crash can leave torn, and whether the open may write.
meta
Payload codecs for the three store-io metadata objects: the volume record, the region table and the region header. Each payload is stored inside an A/B slot pair (see crate::slot); this module only turns typed records into bytes and back, validating everything it reads.
meta2
Payload codecs of container format 2 (docs/FORMAT.md): the 64-byte volume record, the table pages with their 96-byte entries, and the region header with its extent list.
pair
Choosing the current version of an A/B slot pair.
slot
The A/B slot: the one on-disk object every piece of store-io metadata is written with (volume metadata, the region table, region headers, and named small objects).