vendor/flate2/README.md

   1 # flate2
   2
   3 [![Crates.io](https://img.shields.io/crates/v/flate2.svg?maxAge=2592000)](https://crates.io/crates/flate2)
   4 [![Documentation](https://docs.rs/flate2/badge.svg)](https://docs.rs/flate2)
   5
   6 A streaming compression/decompression library DEFLATE-based streams in Rust.
   7
   8 This crate by default uses the `miniz_oxide` crate, a port of `miniz.c` to pure
   9 Rust. This crate also supports other [backends](#Backends), such as the widely
  10 available zlib library or the high-performance zlib-ng library.
  11
  12 Supported formats:
  13
  14 * deflate
  15 * zlib
  16 * gzip
  17
  18 ```toml
  19 # Cargo.toml
  20 [dependencies]
  21 flate2 = "1.0"
  22 ```
  23
  24 ## Compression
  25
  26 ```rust
  27 use std::io::prelude::*;
  28 use flate2::Compression;
  29 use flate2::write::ZlibEncoder;
  30
  31 fn main() {
  32     let mut e = ZlibEncoder::new(Vec::new(), Compression::default());
  33     e.write_all(b"foo");
  34     e.write_all(b"bar");
  35     let compressed_bytes = e.finish();
  36 }
  37 ```
  38
  39 ## Decompression
  40
  41 ```rust,no_run
  42 use std::io::prelude::*;
  43 use flate2::read::GzDecoder;
  44
  45 fn main() {
  46     let mut d = GzDecoder::new("...".as_bytes());
  47     let mut s = String::new();
  48     d.read_to_string(&mut s).unwrap();
  49     println!("{}", s);
  50 }
  51 ```
  52
  53 ## Backends
  54
  55 The default `miniz_oxide` backend has the advantage of being pure Rust, but it
  56 has relatively low performance. For higher performance, you can use zlib
  57 instead:
  58
  59 ```toml
  60 [dependencies]
  61 flate2 = { version = "1.0.17", features = ["zlib"], default-features = false }
  62 ```
  63
  64 This supports either the high-performance zlib-ng backend (in zlib-compat mode)
  65 or the use of a shared system zlib library. To explicitly opt into the fast
  66 zlib-ng backend, use:
  67
  68 ```toml
  69 [dependencies]
  70 flate2 = { version = "1.0.17", features = ["zlib-ng-compat"], default-features = false }
  71 ```
  72
  73 Note that if any crate in your dependency graph explicitly requests stock zlib,
  74 or uses libz-sys directly without `default-features = false`, you'll get stock
  75 zlib rather than zlib-ng. See [the libz-sys
  76 README](https://github.com/rust-lang/libz-sys/blob/main/README.md) for details.
  77
  78 For compatibility with previous versions of `flate2`, the cloudflare optimized
  79 version of zlib is available, via the `cloudflare_zlib` feature. It's not as
  80 fast as zlib-ng, but it's faster than stock zlib. It requires a x86-64 CPU with
  81 SSE 4.2 or ARM64 with NEON & CRC. It does not support 32-bit CPUs at all and is
  82 incompatible with mingw. For more information check the [crate
  83 documentation](https://crates.io/crates/cloudflare-zlib-sys). Note that
  84 `cloudflare_zlib` will cause breakage if any other crate in your crate graph
  85 uses another version of zlib/libz.
  86
  87 For compatibility with previous versions of `flate2`, the C version of `miniz.c`
  88 is still available, using the feature `miniz-sys`.
  89
  90 # License
  91
  92 This project is licensed under either of
  93
  94  * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
  95    http://www.apache.org/licenses/LICENSE-2.0)
  96  * MIT license ([LICENSE-MIT](LICENSE-MIT) or
  97    http://opensource.org/licenses/MIT)
  98
  99 at your option.
 100
 101 ### Contribution
 102
 103 Unless you explicitly state otherwise, any contribution intentionally submitted
 104 for inclusion in this project by you, as defined in the Apache-2.0 license,
 105 shall be dual licensed as above, without any additional terms or conditions.