Skip to main content

Module frame_emit_info

Module frame_emit_info 

Source
Available on crate feature lsm only.
Expand description

Structural metadata describing the layout of an emitted zstd frame.

Surfaced via FrameCompressor::last_frame_emit_info (encode side) after every successful compress(). Lets storage-format consumers discover where each Block_Header / block body / optional content checksum lands in the byte buffer without re-parsing the frame themselves.

Gated behind the lsm Cargo feature (default off) — the FrameCompressor field that stores this info, the methods that return it, and these public types only exist when the feature is enabled. Without lsm the C FFI surface stays strict drop-in for donor libzstd v1.5.7.

Structs§

FrameBlock
Layout of a single zstd block inside an emitted frame.
FrameEmitInfo
Complete layout of an emitted zstd frame.

Enums§

BlockType
There are 4 different kinds of blocks, and the type of block influences the meaning of Block_Size.