Rust replacement for the miniz deflate/zlib encoder/decoder

This project is organized into a C API shell and a rust crate. The Rust crate is found in the miniz_oxide subdirectory.

As of version 0.3, miniz_oxide requires at least rust 1.34 to compile.

For a friendlier streaming API using readers and writers, flate2 can be used, which can use miniz_oxide as a rust-only back-end.

The C API is intented to replicate the api exported from miniz.

NOTE for usage from C: Using from C is currently partly broken as the data structures no longer have the exact same layout that is specified in miniz.h (from the original miniz). Automated headers with CBindgen currently do not work due to an issue in cbindgen, which needs to be fixed worked around so that a proper header can be generated. As such, treat them as opaque pointers, that should be allocated and operated on only by the exported functions.

TODO

$ cargo test
$ ./test.sh

$ cargo bench --features=benching

or to compare to miniz

$ ./travis-after-success.sh

Link against the libminiz_oxide_c_api.a generated by build.sh

Install fuzzer:

$ cargo install cargo-fuzz

Run fuzzer:

$ ./run_fuzz.sh

This library (excluding the miniz C code used for tests) is licensed under the MIT license. The library is based on the miniz C library, of which the parts used are dual-licensed under the MIT license and also the unlicense. The parts of miniz that are not covered by the unlicense is some Zip64 code which is only MIT licensed. This and other Zip functionality in miniz is not part of the miniz_oxidde and miniz_oxide_c_api rust libraries.