#zstd #zstandard #compression


Binding for the zstd compression library

42 releases

0.4.24+zstd.1.4.0 Apr 25, 2019
0.4.22+zstd.1.3.8 Dec 27, 2018
0.4.21+zstd.1.3.7 Oct 19, 2018
0.4.19+zstd.1.3.5 Jun 28, 2018
0.1.3 Mar 2, 2016

#7 in Compression

Download history 437/week @ 2019-02-10 317/week @ 2019-02-17 284/week @ 2019-02-24 432/week @ 2019-03-03 555/week @ 2019-03-10 387/week @ 2019-03-17 1126/week @ 2019-03-24 757/week @ 2019-03-31 705/week @ 2019-04-07 748/week @ 2019-04-14 812/week @ 2019-04-21 912/week @ 2019-04-28 894/week @ 2019-05-05 994/week @ 2019-05-12 795/week @ 2019-05-19

3,230 downloads per month
Used in 19 crates (16 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.


~101K SLoC