Skip to content

Commit

Permalink
doc(miniz_oxide) note that miniz_oxide is no_std
Browse files Browse the repository at this point in the history
  • Loading branch information
oyvindln committed Nov 11, 2021
1 parent cff503a commit ee7eafd
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Main library [![Crates.io](https://img.shields.io/crates/v/miniz_oxide.svg)](htt
C API [![Crates.io](https://img.shields.io/crates/v/miniz_oxide_c_api.svg)](https://crates.io/crates/miniz_oxide_c_api)[![Docs](https://docs.rs/miniz_oxide_c_api/badge.svg)](https://docs.rs/miniz_oxide_c_api)

# miniz_oxide
Pure rust Rust replacement for the [miniz](https://github.com/richgel999/miniz) deflate/zlib encoder/decoder using no unsafe code.
Pure rust Rust replacement for the [miniz](https://github.com/richgel999/miniz) deflate/zlib encoder/decoder using no unsafe code. Builds in [no_std](https://docs.rust-embedded.org/book/intro/no-std.html) mode, though requires the use of `alloc` and `collections` crates.

This project is organized into a C API shell and a rust crate.
The Rust crate is found in the [miniz_oxide subdirectory](https://github.com/Frommi/miniz_oxide/tree/master/miniz_oxide).
Expand Down
2 changes: 2 additions & 0 deletions miniz_oxide/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
A fully safe, pure rust replacement for the [miniz](https://github.com/richgel999/miniz) DEFLATE/zlib encoder/decoder.
The main intention of this crate is to be used as a back-end for the [flate2](https://github.com/alexcrichton/flate2-rs), but it can also be used on it's own. Using flate2 with the ```rust_backend``` feature provides an easy to use streaming API for miniz_oxide.

The library is fully [no_std](https://docs.rust-embedded.org/book/intro/no-std.html), though it requires the use of the `alloc` and `collection` crates as it allocates memory.

miniz_oxide 0.5.x Requires at least rust 1.40.0 0.3.x requires at least rust 0.36.0.

miniz_oxide features no use of unsafe code.
Expand Down

0 comments on commit ee7eafd

Please sign in to comment.