zxc_decompress_opts_t Struct Reference

Options for decompression. More...

#include <zxc_opts.h>

Data Fields
int	n_threads
	Worker thread count (0 = auto-detect CPU cores).
int	checksum_enabled
	1 to verify the block checksums and archive digest, 0 to skip.
const void *	dict
	Pre-trained dictionary content (NULL = none).
size_t	dict_size
	Dictionary size in bytes (0 = none).
const void *	dict_huf
	Shared literal Huffman table: the same 128-byte header used at compression time.
zxc_progress_callback_t	progress_cb
	Optional progress callback (NULL to disable).
void *	user_data
	User context pointer passed to progress_cb.

Detailed Description

Options for decompression.

Zero-initialise for safe defaults.

zxc_decompress_opts_t opts = { .checksum_enabled = 1 };
zxc_stream_decompress(f_in, f_out, &opts);

Definition at line 86 of file zxc_opts.h.

Field Documentation

checksum_enabled

int zxc_decompress_opts_t::checksum_enabled

1 to verify the block checksums and archive digest, 0 to skip.

Definition at line 88 of file zxc_opts.h.

Referenced by zxc_dctx_decode_frame(), zxc_decompress_block(), zxc_decompress_block_safe(), and zxc_stream_decompress().

dict

const void* zxc_decompress_opts_t::dict

Pre-trained dictionary content (NULL = none).

Definition at line 89 of file zxc_opts.h.

Referenced by zxc_dctx_decode_frame(), zxc_decompress_block(), zxc_decompress_block_safe(), and zxc_stream_decompress().

dict_huf

const void* zxc_decompress_opts_t::dict_huf

Shared literal Huffman table: the same 128-byte header used at compression time.

Required if the archive has one, else ZXC_ERROR_DICT_MISMATCH. Ignored without dict.

Definition at line 91 of file zxc_opts.h.

dict_size

size_t zxc_decompress_opts_t::dict_size

Dictionary size in bytes (0 = none).

Definition at line 90 of file zxc_opts.h.

Referenced by zxc_decompress_block_safe().

n_threads

int zxc_decompress_opts_t::n_threads

Worker thread count (0 = auto-detect CPU cores).

Definition at line 87 of file zxc_opts.h.

Referenced by zxc_stream_decompress().

progress_cb

zxc_progress_callback_t zxc_decompress_opts_t::progress_cb

Optional progress callback (NULL to disable).

Definition at line 94 of file zxc_opts.h.

Referenced by zxc_stream_decompress().

user_data

void* zxc_decompress_opts_t::user_data

User context pointer passed to progress_cb.

Definition at line 95 of file zxc_opts.h.

Referenced by zxc_stream_decompress().

---

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

• include/zxc_opts.h