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

#3 in Compression

Download history 7518/week @ 2019-11-07 6541/week @ 2019-11-14 7942/week @ 2019-11-21 5584/week @ 2019-11-28 7706/week @ 2019-12-05 7597/week @ 2019-12-12 5518/week @ 2019-12-19 3761/week @ 2019-12-26 6458/week @ 2020-01-02 7880/week @ 2020-01-09 7323/week @ 2020-01-16 6139/week @ 2020-01-23 7021/week @ 2020-01-30 7718/week @ 2020-02-06 6329/week @ 2020-02-13

24,519 downloads per month
Used in 70 crates (32 directly)

MIT license

140KB
2.5K SLoC

zstd

Build Status crates.io MIT licensed

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

Documentation

1 - Add to cargo.toml

Using cargo-edit

$ cargo add zstd

Manually

# Cargo.toml

[dependencies]
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();
    encoder.finish().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

TODO

  • Benchmarks, optimizations, ...

Disclaimer

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

License

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

Dependencies

~5MB
~102K SLoC