1# libz-ng-sys
2
3A library for linking zlib-ng (`libz-ng`) to Rust programs natively, rather
4than in zlib-compat mode.
5
6zlib-ng is a high-performance implementation of zlib. zlib-ng supports building
7in two modes: zlib-compat mode, in whih it provides the same API as zlib and
8generally works as a drop-in replacement, and native mode, in which it provides
9its own API. The native API is almost identical to the zlib-compat API, except
10that some types use more correct sizes (rather than the sizes required for zlib
11compatibility), and the functions all have a `zng_` prefix. The latter allows
12zlib and zlib-ng to coexist in the same program.
13
14This crate provides bindings to the native zlib-ng API. However, for simplicity
15of porting, this crate exports the same API as libz-sys (without the `zng_`
16prefixes), making it easier to write Rust software compatible with both
17libz-sys and libz-ng-sys.
18
19# High-level API
20
21This crate provides bindings to the raw low-level C API. For a higher-level
22safe API to work with DEFLATE, zlib, or gzip streams, see
23[`flate2`](https://docs.rs/flate2). `flate2` supports many different
24implementations.
25
26# License
27
28This project is licensed under either of
29
30 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
31   http://www.apache.org/licenses/LICENSE-2.0)
32 * MIT license ([LICENSE-MIT](LICENSE-MIT) or
33   http://opensource.org/licenses/MIT)
34
35at your option.
36
37### Contribution
38
39Unless you explicitly state otherwise, any contribution intentionally submitted
40for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
41be dual licensed as above, without any additional terms or conditions.
42