Skip to content

Payload's sub-header

Described below is the format of the 32-byte-long payload sub-header. This format is unique to v1.

FieldTypeSize (bytes)Description
stored_sizeuint8

Compressed size, in bytes, of the records. If records are not compressed, stored_size is equal to plain_size.

plain_sizeuint8Uncompressed size, in bytes, of records.
checksumblob8Checksum of records, computed using XXH3_64bits.
num_recordsuint4Number of records contained in the payload.
versionuint2Version of the payload data format. Unused.
record_kinduint1Kind of records that the payload contains.
compressionuint1Compression algorithm used for the records.

record_kind is an enum. The following table lists all possible values:

ValueName
1Meta
2Content
3Layout
4Index
5Attributes
ValueName
1Uncompressed
2Zstd