Skip to main content

Crate fbz

Crate fbz 

Source
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.
BlockCandidate
BlockIndex
Bzip2EncodeReport
Bzip2Encoder
DecodeOptions
DecodeProgress
EncodeOptions
EncodeProgress
EncodeReport
EndCandidate
Index
IndexedReader
Reader
A streaming, parallel bzip2, gzip, or LZ4 decoder for file-backed streams.
ScanResult
Candidate stream headers and bit-level block markers found in a bzip2 input.
Source
StreamHeaderCandidate
StreamIndex
WriterSink
Adapts any std::io::Write destination to an OutputSink.

Enums§

DecodeError
DecodeFormat
A byte-stream compression format accepted by the unified decoders.
EncodeFormat
Encoder
Error
Format
A compression or archive format recognized by fbz.

Constants§

BLOCK_MAGIC
DEFAULT_CACHE_LIMIT
DEFAULT_MEMORY_LIMIT
END_MAGIC
MAX_DECODED_BLOCK
MAX_ENCODED_BLOCK

Traits§

OutputSink
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

Type Aliases§

Result