47 releases

✓ Uses Rust 2018 edition

0.5.1+zstd.1.4.4 Nov 5, 2019
0.4.28+zstd.1.4.3 Aug 20, 2019
0.4.27+zstd.1.4.2 Jul 25, 2019
0.4.22+zstd.1.3.8 Dec 27, 2018
0.1.3 Mar 2, 2016

#4 in Compression

Download history 3606/week @ 2019-10-13 4303/week @ 2019-10-20 5085/week @ 2019-10-27 7909/week @ 2019-11-03 6651/week @ 2019-11-10 7116/week @ 2019-11-17 6740/week @ 2019-11-24 6857/week @ 2019-12-01 8407/week @ 2019-12-08 5578/week @ 2019-12-15 4460/week @ 2019-12-22 4321/week @ 2019-12-29 8353/week @ 2020-01-05 7633/week @ 2020-01-12 6568/week @ 2020-01-19

24,519 downloads per month
Used in 66 crates (31 directly)

MIT license

2.5K SLoC


Build Status crates.io MIT licensed

This library is a rust binding for the zstd compression library.


1 - Add to cargo.toml

Using cargo-edit

$ cargo add zstd


# Cargo.toml

zstd = "0.4"

2 - Usage

This library provides Read and Write wrappers to handle (de)compression, along with convenience functions to made common tasks easier.

For instance, stream::copy_encode and stream::copy_decode are easy-to-use wrappers around std::io::copy. Check the stream example:

extern crate zstd;

use std::io;

// This function use the convenient `copy_encode` method
fn compress(level: i32) {
    zstd::stream::copy_encode(io::stdin(), io::stdout(), level).unwrap();

// This function does the same thing, directly using an `Encoder`:
fn compress_manually(level: i32) {
    let mut encoder = zstd::stream::Encoder::new(io::stdout(), level).unwrap();
    io::copy(&mut io::stdin(), &mut encoder).unwrap();

fn decompress() {
    zstd::stream::copy_decode(io::stdin(), io::stdout()).unwrap();

Asynchronous support

You can use this library to wrap non-blocking writer/readers: add the tokio feature, and stream::Encoder and stream::Decoder will implement AsyncWrite and AsyncRead, respectively.

Compile it yourself

zstd is included as a submodule. To get everything during your clone, use:

git clone https://github.com/gyscos/zstd-rs --recursive

Or, if you cloned it without the --recursive flag, call this from inside the repository:

git submodule update --init

Then, running cargo build should take care of building the C library and linking to it.

Build-time bindgen

This library includes a pre-generated bindings.rs file. You can also generate new bindings at build-time, using the bindgen feature:

cargo build --features bindgen


  • Benchmarks, optimizations, ...


This implementation is largely inspired by bozaro's lz4-rs.


  • The zstd C library is under a dual BSD/GPLv2 license.
  • This zstd-rs binding library is under a MIT license.


~102K SLoC