Skip to content

Commit

Permalink
Merge pull request rust-lang#163 from robinst/patch-1
Browse files Browse the repository at this point in the history
Recommend using bufread types for decoding `&[u8]`
  • Loading branch information
alexcrichton authored Aug 1, 2018
2 parents f7d428e + 2e69f17 commit 0393c50
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,12 @@
//!
//! This crate consists mainly of three modules, [`read`], [`write`], and
//! [`bufread`]. Each module contains a number of types used to encode and
//! decode various streams of data. All types in the [`write`] module work on
//! instances of [`Write`][write], whereas all types in the [`read`] module work on
//! instances of [`Read`][read] and [`bufread`] works with [`BufRead`][bufread].
//! decode various streams of data.
//!
//! All types in the [`write`] module work on instances of [`Write`][write],
//! whereas all types in the [`read`] module work on instances of
//! [`Read`][read] and [`bufread`] works with [`BufRead`][bufread]. If you
//! are decoding directly from a `&[u8]`, use the [`bufread`] types.
//!
//! ```
//! use flate2::write::GzEncoder;
Expand Down

0 comments on commit 0393c50

Please sign in to comment.