Module data

yzx_core::frame

Module data 

Source
Expand description

Encoding of a Zstandard frame.

A “Zstandard frame” (somewhat confusingly) refers to a single specific type of frame which may appear in a Zstandard data stream. This frame type is also currently the only kind which is specified to produce decoded output data. Therefore, this codebase uses the term “data frame”.

This frame type’s encoding is specified in section 3.1.1 of IETF RFC 88781:

                    +--------------------+------------+
                    | Magic_Number       | 4 bytes    |
                    +--------------------+------------+
                    | Frame_Header       | 2-14 bytes |
                    +--------------------+------------+
                    | Data_Block         | n bytes    |
                    +--------------------+------------+
                    | [More Data_Blocks] |            |
                    +--------------------+------------+
                    | [Content_Checksum] | 4 bytes    |
                    +--------------------+------------+

  1. https://datatracker.ietf.org/doc/html/rfc8878#section-3.1.1 ↩

Modules§

block
header

Constants§

MAGIC
The “magic number” identifying the start of a data frame.