Fix and unify docs of `bufread` and `read` types.

rust-lang / flate2-rs

DEFLATE, gzip, and zlib bindings for Rust

https://docs.rs/flate2

Apache License 2.0

862 stars 159 forks source link

Closed georeth closed 10 months ago

georeth commented 10 months ago

Goals:

fix wrong docs of bufread::GzDecoder, bufread::GzEncoder, bufread::MultiGzDecoder.
make the types of inner reader and exported trait explicit.
explicit state the pull model: user initialize the read, then data is read from the underlying stream.

Fix #374

I'm not a fluent english speaker and know little about flate2 internals, feel free to edit this PR.

georeth commented 10 months ago

@Byron