zstd

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.1"

2 - Usage

Check the stream example:

extern crate zstd;

use std::io;

fn compress(level: i32) {
    let mut encoder = zstd::Encoder::new(io::stdout(), level).unwrap().auto_finish();
	io::copy(&mut io::stdin(), &mut encoder).unwrap();
}

fn decompress() {
	let mut decoder = zstd::Decoder::new(io::stdin()).unwrap();
	io::copy(&mut decoder, &mut io::stdout()).unwrap();
}

Compile it yourself

This repository includes zstd 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.

TODO

• Benchmarks, optimizations, ...

Disclaimer

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

License

MIT