mirror of
https://git.proxmox.com/git/rustc
synced 2025-08-16 00:29:23 +00:00
83 lines
1.8 KiB
Markdown
83 lines
1.8 KiB
Markdown
# flate2
|
|
|
|
[](https://crates.io/crates/flate2)
|
|
[](https://docs.rs/flate2)
|
|
|
|
A streaming compression/decompression library DEFALTE-based streams in Rust.
|
|
|
|
This crate by default implemented as a wrapper around the `miniz_oxide` crate, a
|
|
port of `miniz.c` to Rust. This crate can also optionally use the zlib library
|
|
or `miniz.c` itself.
|
|
|
|
Supported formats:
|
|
|
|
* deflate
|
|
* zlib
|
|
* gzip
|
|
|
|
```toml
|
|
# Cargo.toml
|
|
[dependencies]
|
|
flate2 = "1.0"
|
|
```
|
|
|
|
Using zlib instead of the Rust backend:
|
|
|
|
```toml
|
|
[dependencies]
|
|
flate2 = { version = "1.0", features = ["zlib"], default-features = false }
|
|
```
|
|
|
|
Using `miniz.c`:
|
|
|
|
```toml
|
|
[dependencies]
|
|
flate2 = { version = "1.0", features = ["miniz-sys"], default-features = false }
|
|
```
|
|
|
|
## Compression
|
|
|
|
```rust
|
|
use std::io::prelude::*;
|
|
use flate2::Compression;
|
|
use flate2::write::ZlibEncoder;
|
|
|
|
fn main() {
|
|
let mut e = ZlibEncoder::new(Vec::new(), Compression::default());
|
|
e.write_all(b"foo");
|
|
e.write_all(b"bar");
|
|
let compressed_bytes = e.finish();
|
|
}
|
|
```
|
|
|
|
## Decompression
|
|
|
|
```rust,no_run
|
|
use std::io::prelude::*;
|
|
use flate2::read::GzDecoder;
|
|
|
|
fn main() {
|
|
let mut d = GzDecoder::new("...".as_bytes());
|
|
let mut s = String::new();
|
|
d.read_to_string(&mut s).unwrap();
|
|
println!("{}", s);
|
|
}
|
|
```
|
|
|
|
# License
|
|
|
|
This project is licensed under either of
|
|
|
|
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
|
http://www.apache.org/licenses/LICENSE-2.0)
|
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
|
|
http://opensource.org/licenses/MIT)
|
|
|
|
at your option.
|
|
|
|
### Contribution
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
for inclusion in this project by you, as defined in the Apache-2.0 license,
|
|
shall be dual licensed as above, without any additional terms or conditions.
|