zxc_frame_info_t Struct Reference

What a frame's header and footer declare, read without decoding. More...

#include <zxc_buffer.h>

Data Fields
uint64_t	decompressed_size
	Source bytes the frame decodes to.
uint64_t	compressed_size
	Compressed bytes of the frame, footer included.
uint64_t	digest
	Archive digest; 0 when has_checksum is 0.
size_t	block_size
	Block size, 4 KB to 2 MB.
uint32_t	dict_id
	Dictionary the frame needs; 0 for none.
uint8_t	format_version
	Format version of the frame.
uint8_t	has_checksum
	1 when blocks carry checksums and the footer a digest.
uint8_t	has_seek_table
	1 when a seek table precedes the footer.

Detailed Description

What a frame's header and footer declare, read without decoding.

Filled by zxc_get_frame_info(), zxc_get_last_frame_info() and their FILE* twins; pass them sizeof(zxc_frame_info_t). Fields are only ever added at the end: zero the struct first to read the ones this library does not know as 0.

Definition at line 235 of file zxc_buffer.h.

Field Documentation

block_size

size_t zxc_frame_info_t::block_size

Block size, 4 KB to 2 MB.

Definition at line 239 of file zxc_buffer.h.

Referenced by zxc_inplace_probe(), zxc_read_frame_info(), zxc_scan_container(), and zxc_seek_parse_frame().

compressed_size

uint64_t zxc_frame_info_t::compressed_size

Compressed bytes of the frame, footer included.

Definition at line 237 of file zxc_buffer.h.

Referenced by zxc_read_frame_info().

decompressed_size

uint64_t zxc_frame_info_t::decompressed_size

Source bytes the frame decodes to.

Definition at line 236 of file zxc_buffer.h.

Referenced by zxc_inplace_probe(), zxc_read_frame_info(), zxc_scan_container(), and zxc_seek_parse_frame().

dict_id

uint32_t zxc_frame_info_t::dict_id

Dictionary the frame needs; 0 for none.

Definition at line 240 of file zxc_buffer.h.

Referenced by zxc_read_frame_info(), zxc_scan_container(), and zxc_seek_parse_frame().

digest

uint64_t zxc_frame_info_t::digest

Archive digest; 0 when has_checksum is 0.

Definition at line 238 of file zxc_buffer.h.

Referenced by zxc_read_frame_info().

format_version

uint8_t zxc_frame_info_t::format_version

Format version of the frame.

Definition at line 241 of file zxc_buffer.h.

Referenced by zxc_read_frame_info().

has_checksum

uint8_t zxc_frame_info_t::has_checksum

1 when blocks carry checksums and the footer a digest.

Definition at line 242 of file zxc_buffer.h.

Referenced by zxc_inplace_probe(), zxc_read_frame_info(), and zxc_seek_parse_frame().

has_seek_table

uint8_t zxc_frame_info_t::has_seek_table

1 when a seek table precedes the footer.

Definition at line 243 of file zxc_buffer.h.

Referenced by zxc_inplace_probe(), zxc_read_frame_info(), and zxc_seek_parse_frame().

---

The documentation for this struct was generated from the following file:

• include/zxc_buffer.h