1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
# zstd
[](https://crates.io/crates/zstd)
[](./LICENSE)
[](https://github.com/gyscos/zstd-rs/actions/workflows/linux.yml)
[](https://github.com/gyscos/zstd-rs/actions/workflows/windows.yml)
[](https://github.com/gyscos/zstd-rs/actions/workflows/macos.yml)
[](https://github.com/gyscos/zstd-rs/actions/workflows/wasm.yml)
This library is a rust binding for the [zstd compression library][zstd].
# [Documentation][doc]
## 1 - Add to `cargo.toml`
```bash
$ cargo add zstd
```
```toml
# 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:
```rust
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`](https://github.com/Nemo157/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) license.
[zstd]: https://github.com/facebook/zstd
[lz4-rs]: https://github.com/bozaro/lz4-rs
[cargo-edit]: https://github.com/killercup/cargo-edit#cargo-add
[doc]: https://docs.rs/zstd
[stream]: examples/stream.rs
[submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
|
