Expand description
Streaming compression functionality.
Modules§
Structs§
- BitBuffer 🔒
- Callback
Buf 🔒 - Callback
Func - Callback function and user used in
compress_to_output. - Callback
Oxide 🔒 - Compressor
Oxide - Main compression struct.
- Dict
Oxide 🔒 - Error 🔒
- Huffman
Oxide 🔒 - A struct containing data about huffman codes and symbol frequencies.
- LZOxide 🔒
- Output
Buffer 🔒Oxide - Params
Oxide 🔒 - Rle 🔒
- Status of RLE encoding of huffman code lengths.
- Saved
Output 🔒Buffer Oxide - SymFreq 🔒
Enums§
- Callback
Out 🔒 - Compression
Strategy - Strategy setting for compression.
- TDEFL
Flush - A list of deflate flush types.
- TDEFL
Status - Return status of compression.
Constants§
- BITMASKS 🔒
- COMP_
FAST_ 🔒LOOKAHEAD_ SIZE - DEFAULT_
FLAGS 🔒 - DIST_
TABLE 🔒 - Tables for distances.
- HUFF_
CODES_ 🔒TABLE - Tables for the run-length encoded huffman lengths for literals/lengths/distances.
- LARGE_
DIST_ 🔒EXTRA - Number of extra bits distances above 512.
- LARGE_
DIST_ 🔒SYM - Base values to calculate distances above 512.
- LEN_
EXTRA 🔒 - Number of extra bits for length values.
- LEN_SYM 🔒
- LEN_
SYM_ 🔒OFFSET - LEVE
L1_ 🔒HASH_ SIZE_ MASK - Size of hash chain for fast compression mode.
- LITLEN_
TABLE 🔒 - Tables used for literal/lengths in
HuffmanOxide. - LZ_
DICT_ 🔒SIZE - Size of the chained hash table.
- LZ_
DICT_ 🔒SIZE_ MASK - Mask used when stepping through the hash chains.
- MAX_
HUFF_ 🔒SYMBOLS - MAX_
HUFF_ 🔒SYMBOLS_ 0 - Literal/length codes
- MAX_
HUFF_ 🔒SYMBOLS_ 1 - Distance codes.
- MAX_
HUFF_ 🔒SYMBOLS_ 2 - Huffman length values.
- MAX_
HUFF_ 🔒TABLES - The number of huffman tables used by the compressor. Literal/length, Distances and Length of the huffman codes for the other two tables.
- MAX_
MATCH_ 🔒LEN - The maximum length of a match.
- MAX_
PROBES_ 🔒MASK - MAX_
SUPPORTED_ 🔒HUFF_ CODESIZE - MIN_
MATCH_ 🔒LEN - The minimum length of a match.
- NUM_
PROBES 🔒 - The maximum number of checks for matches in the hash table the compressor will make for each compression level.
- SMALL_
DIST_ 🔒EXTRA - Number of extra bits for distances smaller than 512.
- SMALL_
DIST_ 🔒SYM - Distance codes for distances smaller than 512.
Functions§
- compress
- Main compression function. Tries to compress as much as possible from
in_bufand puts compressed output intoout_buf. - compress_
block 🔒 - compress_
fast 🔒 - compress_
inner 🔒 - compress_
lz_ 🔒codes - compress_
normal 🔒 - compress_
to_ output - Main compression function. Callbacks output.
- create_
comp_ flags_ from_ zip_ params - Create a set of compression flags using parameters used by zlib and other compressors. Mainly intended for use with transition from c libraries as it deals with raw integers.
- flush_
block 🔒 - flush_
output_ 🔒buffer - probes_
from_ 🔒flags - read_
u16_ 🔒le - record_
literal 🔒 - record_
match 🔒 - write 🔒
Type Aliases§
- Result 🔒