Expand description
The fixed .voldoc header.
A descriptor begins with exactly HEADER_LEN bytes. The header is
self-checked with CRC32C so that framing corruption is detected before any
record parsing. Unknown mandatory feature bits fail closed; unknown
optional bits are recorded and ignored.
Structs§
- Header
- The parsed, validated fixed header.
Constants§
- FEATURE_
DEFLATE_ REPLAY - Mandatory feature bit: the descriptor carries at least one
DEFLATE_REPLAYop and so requires a decoder built with exact-DEFLATE-replay support. - FEATURE_
EXTERNAL_ OBJECTS - Mandatory feature bit: the descriptor carries at least one
EXTERNAL_REFobject and so requires a decoder built with a content-addressed object store. - FEATURE_
OBSERVATION_ INDEX - Optional feature bit: the descriptor carries an
OBSERVATION_INDEXrecord and so advertises a partial-decode lane. - FEATURE_
SEEK_ DIRECTORY - Optional feature bit: the descriptor carries a seek
DIRECTORYrecord and so advertises a seek-based partial-I/O lane. - FORMAT_
MAJOR - Major format version implemented by this build (provisional pre-1.0).
- FORMAT_
MINOR - Minor format version implemented by this build.
- HEADER_
LEN - Size of the fixed header in bytes.
- MAGIC
- Container magic:
VOLDOCfollowed by a 0x1A text-EOF marker and NUL. - SUPPORTED_
MANDATORY_ FEATURES - Feature bits this build understands and supports (no replay support).