Skip to content
/ zstd-rs Public
forked from gyscos/zstd-rs

A rust binding for the zstd compression library.

License

Notifications You must be signed in to change notification settings

kpcyrd/zstd-rs

This branch is 1 commit ahead of, 15 commits behind gyscos/zstd-rs:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

1f2e186 · Nov 11, 2024
May 24, 2024
Mar 23, 2021
Jun 21, 2024
Sep 3, 2024
Jan 11, 2023
Nov 11, 2024
Oct 19, 2018
Dec 21, 2017
Jun 5, 2017
Nov 11, 2024
Feb 23, 2016
Oct 11, 2023
Aug 16, 2017

Repository files navigation

zstd

crates.io MIT licensed

Build on Linux Build on Windows Build on macOS Build on wasm

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

1 - Add to cargo.toml

$ cargo add zstd
# Cargo.toml

[dependencies]
zstd = "0.13"

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:

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

The async-compression crate provides an async-ready integration of various compression algorithms, including zstd-rs.

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.

About

A rust binding for the zstd compression library.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 98.7%
  • Other 1.3%