Skip to main content

Module header

Module header 

Source
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_REPLAY op and so requires a decoder built with exact-DEFLATE-replay support.
FEATURE_EXTERNAL_OBJECTS
Mandatory feature bit: the descriptor carries at least one EXTERNAL_REF object and so requires a decoder built with a content-addressed object store.
FEATURE_OBSERVATION_INDEX
Optional feature bit: the descriptor carries an OBSERVATION_INDEX record and so advertises a partial-decode lane.
FEATURE_SEEK_DIRECTORY
Optional feature bit: the descriptor carries a seek DIRECTORY record 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: VOLDOC followed by a 0x1A text-EOF marker and NUL.
SUPPORTED_MANDATORY_FEATURES
Feature bits this build understands and supports (no replay support).