libflate/non_blocking/deflate/mod.rs
1//! The decoder of the DEFLATE format and algorithm.
2//!
3//! The DEFLATE is defined in [RFC-1951](https://tools.ietf.org/html/rfc1951).
4//!
5//! # Examples
6//! ```
7//! use no_std_io2::io::{Read, Write};
8//! use libflate::deflate::Encoder;
9//! use libflate::non_blocking::deflate::Decoder;
10//!
11//! // Encoding
12//! let mut encoder = Encoder::new(Vec::new());
13//! encoder.write_all(b"Hello World!".as_ref()).unwrap();
14//! let encoded_data = encoder.finish().into_result().unwrap();
15//!
16//! // Decoding
17//! let mut decoder = Decoder::new(&encoded_data[..]);
18//! let mut decoded_data = Vec::new();
19//! decoder.read_to_end(&mut decoded_data).unwrap();
20//!
21//! assert_eq!(decoded_data, b"Hello World!");
22//! ```
23pub use self::decode::Decoder;
24
25mod decode;