Crate async_compression

source ·
Expand description

Adaptors between compression crates and Rust’s modern asynchronous IO types.

§Feature Organization

This crate is divided up along two axes, which can each be individually selected via Cargo features.

All features are disabled by default, you should enable just the ones you need from the lists below.

If you want to pull in everything there are three group features defined:

FeatureDoes
allActivates all implementations and algorithms.
all-implementationsActivates all implementations, needs to be paired with a selection of algorithms
all-algorithmsActivates all algorithms, needs to be paired with a selection of implementations

§IO implementation

The first division is which underlying asynchronous IO trait will be wrapped, these are available as separate features that have corresponding top-level modules:

FeatureType
futures-io (inactive)futures::io::AsyncBufRead, futures::io::AsyncWrite
tokiotokio::io::AsyncBufRead, tokio::io::AsyncWrite

§Compression algorithm

The second division is which compression schemes to support, there are currently a few available choices, these determine which types will be available inside the above modules:

FeatureTypes
brotli (inactive)BrotliEncoder, BrotliDecoder
bzip2 (inactive)BzEncoder, BzDecoder
deflate (inactive)DeflateEncoder, DeflateDecoder
gzipGzipEncoder, GzipDecoder
lzma (inactive)LzmaEncoder, LzmaDecoder
xz (inactive)XzEncoder, XzDecoder
zlib (inactive)ZlibEncoder, ZlibDecoder
zstd (inactive)ZstdEncoder, ZstdDecoder
deflate64 (inactive)(encoder not implemented), Deflate64Decoder

Modules§

Enums§

  • Level of compression data should be compressed with.