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 ๐