Expand description
Fast parallel compression and decompression for bzip2, gzip, LZ4, and ZIP.
Re-exports§
pub use decode::DEFAULT_MEMORY_LIMIT;pub use decode::DecodeOptions;pub use decode::DecodeProgress;pub use decode::build_index;pub use decode::build_index_with_progress;pub use decode::decode_to_writer;pub use decode::decode_to_writer_with_progress;pub use decode::decompress as decompress_bzip2;pub use decode::decompress_to_writer as decompress_bzip2_to_writer;pub use decode::decompress_to_writer_with_progress as decompress_bzip2_to_writer_with_progress;pub use output::OutputSink;pub use output::WriterSink;pub use stream::DecodeFormat;pub use stream::Format;pub use stream::decompress;pub use stream::decompress_to_writer;pub use stream::decompress_to_writer_with_progress;
Modules§
- deflate
- Raw DEFLATE compression and decompression shared by gzip and ZIP framing.
- gzip
- Gzip framing and DEFLATE compression/decompression implemented in safe Rust.
- lz4
- LZ4 frame and block compression/decompression implemented in safe Rust.
- zip
- ZIP archive creation using fbz’s raw-DEFLATE encoder.
Structs§
- BitReader
- An MSB-first reader over an in-memory bzip2 bitstream.
- Block
Candidate - Block
Index - Bzip2
Encode Report - Bzip2
Encoder - Decode
Options - Decode
Progress - Encode
Options - Encode
Progress - Encode
Report - EndCandidate
- Index
- Indexed
Reader - Reader
- A streaming, parallel bzip2, gzip, or LZ4 decoder for file-backed streams.
- Scan
Result - Candidate stream headers and bit-level block markers found in a bzip2 input.
- Source
- Stream
Header Candidate - Stream
Index - Writer
Sink - Adapts any
std::io::Writedestination to anOutputSink.
Enums§
- Decode
Error - Decode
Format - A byte-stream compression format accepted by the unified decoders.
- Encode
Format - Encoder
- Error
- Format
- A compression or archive format recognized by fbz.
Constants§
Traits§
- Output
Sink - Receives decoded bytes and can take ownership of decoder chunks.
Functions§
- build_
index - build_
index_ with_ progress - bz2_
crc32 - Compute the CRC used for an uncompressed bzip2 block.
- combine_
stream_ crc - Add a block CRC to bzip2’s combined stream CRC.
- compress
- compress_
bzip2 - compress_
bzip2_ to_ writer - compress_
to_ writer - compress_
to_ writer_ with_ progress - decode_
block - Decode and CRC-validate one bzip2 block bounded by two exact markers.
- decode_
to_ writer - Decode a complete bzip2 input, validate every CRC, and build its block index.
- decode_
to_ writer_ with_ progress - Decode a complete bzip2 input, return its index, and report completed work.
- decompress
- Decode bzip2, gzip, or LZ4 bytes selected by magic or
options.format. - decompress_
bzip2 - decompress_
bzip2_ to_ writer - Decode to a streaming output. A one-thread request uses the same pure-Rust block codec without the indexing/speculation overhead.
- decompress_
bzip2_ to_ writer_ with_ progress - decompress_
to_ writer - Decode bzip2, gzip, or LZ4 bytes to a streaming output.
- decompress_
to_ writer_ with_ progress - Decode a byte stream and report completed compressed and decoded bytes.
- scan