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:
| Feature | Does |
|---|---|
all | Activates all implementations and algorithms. |
all-implementations | Activates all implementations, needs to be paired with a selection of algorithms |
all-algorithms | Activates 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:
| Feature | Type |
|---|---|
futures-io (inactive) | futures::io::AsyncBufRead, futures::io::AsyncWrite |
stream (inactive) | (deprecated, see async-compression::stream docs for migration) |
tokio-02 (inactive) | tokio::io::AsyncBufRead, tokio::io::AsyncWrite |
tokio-03 (inactive) | tokio::io::AsyncBufRead, tokio::io::AsyncWrite |
tokio | tokio::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:
| Feature | Types |
|---|---|
brotli (inactive) | BrotliEncoder, BrotliDecoder |
bzip2 (inactive) | BzEncoder, BzDecoder |
deflate (inactive) | DeflateEncoder, DeflateDecoder |
gzip | GzipEncoder, GzipDecoder |
lzma (inactive) | LzmaEncoder, LzmaDecoder |
xz (inactive) | XzEncoder, XzDecoder |
zlib (inactive) | ZlibEncoder, ZlibDecoder |
zstd (inactive) | ZstdEncoder, ZstdDecoder |
Modules
Implementations for IO traits exported by tokio v1.0.
Enums
Level of compression data should be compressed with.