PyDocs

Nav

Data Compression and Archiving

get_frame_info

  • get_frame_info(frame_buffer)
Get Zstandard frame information from a frame header.

*frame_buffer* is a bytes-like object. It should start from the
beginning of a frame, and needs to include at least the frame header
(6 to 18 bytes).

The returned FrameInfo object has two attributes.
'decompressed_size' is the size in bytes of the data in the frame when
decompressed, or None when the decompressed size is unknown.
'dictionary_id' is an int in the range (0, 2**32). The special value 0
means that the dictionary ID was not recorded in the frame header,
the frame may or may not need a dictionary to be decoded,
and the ID of such a dictionary is not specified.
0 Examples
No examples for compression.zstd/get_frame_info.
See Also
No see-alsos for compression.zstd/get_frame_info
0 Notes
No notes for get_frame_info