Skip to content
FLATE, Gzip, and Zlib bindings for Rust
Branch: master
Clone or download
Latest commit 85166b2 Mar 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci Refactor pipelines configuration slightly Feb 22, 2019
examples Run `cargo fmt` Dec 18, 2018
miniz-sys Run `cargo fmt` Dec 18, 2018
src Fix lifetime for rustc 1.30 Mar 14, 2019
systest
tests use buffer Feb 22, 2019
.gitattributes
.gitignore
Cargo.toml
LICENSE-APACHE
LICENSE-MIT
README.md
azure-pipelines.yml

README.md

flate2

Build Status Crates.io Documentation

A streaming compression/decompression library for Rust. The underlying implementation by default uses miniz but can optionally be configured to use the system zlib, if available.

There is also an experimental rust backend that uses the miniz_oxide crate. This avoids the need to build C code, but hasn't gone through as much testing as the other backends.

Supported formats:

  • deflate
  • zlib
  • gzip
# Cargo.toml
[dependencies]
flate2 = "1.0"

Using zlib instead of miniz:

[dependencies]
flate2 = { version = "1.0", features = ["zlib"], default-features = false }

Using the rust back-end:

[dependencies]
flate2 = { version = "1.0", features = ["rust_backend"], default-features = false }

Compression

extern crate flate2;

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

extern crate flate2;

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

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.

You can’t perform that action at this time.