Crate async_compression

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	futures::io::AsyncBufRead, futures::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	BrotliEncoder, BrotliDecoder
bzip2	BzEncoder, BzDecoder
deflate	DeflateEncoder, DeflateDecoder
gzip	GzipEncoder, GzipDecoder
lz4	Lz4Encoder, Lz4Decoder
lzma	LzmaEncoder, LzmaDecoder
xz	XzEncoder, XzDecoder
zlib	ZlibEncoder, ZlibDecoder
zstd	ZstdEncoder, ZstdDecoder
deflate64	(encoder not implemented), Deflate64Decoder

Modules

brotlibrotli

This module contains Brotli-specific types for async-compression.

futuresfutures-io

Implementations for IO traits exported by futures-io.

lz4lz4

This module contains lz4-specific types for async-compression.

tokiotokio

Implementations for IO traits exported by tokio v1.x.

zstdzstd

This module contains zstd-specific types for async-compression.

Enums

Level

Level of compression data should be compressed with.