#zlib #deflate #encoding #miniz

miniz_oxide_c_api

DEFLATE compression and decompression API designed to be Rust drop-in replacement for miniz

9 releases

0.2.4 Oct 1, 2019
0.2.3 Jul 22, 2019
0.2.1 Jan 23, 2019
0.2.0 Oct 16, 2018
0.1.1 Oct 28, 2017

#10 in Compression

Download history 49118/week @ 2019-07-22 46474/week @ 2019-07-29 48262/week @ 2019-08-05 45060/week @ 2019-08-12 29628/week @ 2019-08-19 27123/week @ 2019-08-26 26423/week @ 2019-09-02 26135/week @ 2019-09-09 25727/week @ 2019-09-16 22855/week @ 2019-09-23 22085/week @ 2019-09-30 23760/week @ 2019-10-07 21919/week @ 2019-10-14 19615/week @ 2019-10-21 18127/week @ 2019-10-28

151,343 downloads per month
Used in 5 crates (1 directly)

MIT license

560KB
9K SLoC

Rust 5K SLoC // 0.2% comments C 4K SLoC // 0.4% comments

miniz_oxide

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.

miniz_oxide_C_API

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.

API documentation

TODO

Testing

$ cargo test
$ ./test.sh

Benches

$ cargo bench --features=benching

or to compare to miniz

$ ./travis-after-success.sh

Including in C/C++ projects

Link against the libminiz_oxide_c_api.a generated by build.sh

Cargo-fuzz testing

Install fuzzer:

$ cargo install cargo-fuzz

Run fuzzer:

$ ./run_fuzz.sh

License

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.

Dependencies

~235KB