libzxc API Reference

ZXC is a lossless data compression library built for high decompression throughput and random access. An archive is a sequence of independently decodable blocks, optionally indexed by a seek table, so any block can be decompressed without reading the blocks before it.

This is the generated API reference. For the project overview, benchmarks and installation instructions see the README; for the wire format see the format specification.

Complete, runnable workflows for each of these APIs are collected in the API Examples page.

Choosing an API

• Buffer API — one-call compression of a whole buffer. Start here.
• Reusable Context API — reuse one context across many operations to avoid repeated allocation.
• Static Context API — caller-provided workspace, no heap allocation.
• Block API — single blocks, without the archive header and footer.
• Streaming API and Push Streaming API — incremental pull and push streaming.
• Seekable API — random access to any block of a seekable archive.
• Dictionary — pre-trained dictionaries for small, homogeneous payloads.

Reference

• Error Handling — error codes and their meaning.
• Compression Levels — compression levels.
• Block Size — block-size codes and limits.
• File Format Constants — on-disk format constants.
• Library Information and Library Version — build and version queries.
• Threading Limits — thread-count limits.