1 // Copyright 2012 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Simple [DEFLATE][def]-based compression. This is a wrapper around the
12 //! [`miniz`][mz] library, which is a one-file pure-C implementation of zlib.
14 //! [def]: https://en.wikipedia.org/wiki/DEFLATE
15 //! [mz]: https://code.google.com/p/miniz/
17 #![crate_name = "flate"]
18 #![unstable(feature = "rustc_private", issue = "27812")]
19 #![crate_type = "rlib"]
20 #![crate_type = "dylib"]
21 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
22 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
23 html_root_url = "https://doc.rust-lang.org/nightly/",
24 test(attr(deny(warnings))))]
25 #![cfg_attr(not(stage0), deny(warnings))]
28 #![feature(staged_api)]
30 #![cfg_attr(test, feature(rustc_private, rand, vec_push_all))]
38 use libc::{c_void, size_t, c_int};
44 #[derive(Clone, Eq, Hash, Ord, PartialEq, PartialOrd)]
55 impl fmt::Debug for Error {
56 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
57 "decompression error".fmt(f)
66 impl Deref for Bytes {
68 fn deref(&self) -> &[u8] {
69 unsafe { slice::from_raw_parts(*self.ptr, self.len) }
76 libc::free(*self.ptr as *mut _);
81 #[link(name = "miniz", kind = "static")]
83 /// Raw miniz compression function.
84 fn tdefl_compress_mem_to_heap(psrc_buf: *const c_void,
86 pout_len: *mut size_t,
90 /// Raw miniz decompression function.
91 fn tinfl_decompress_mem_to_heap(psrc_buf: *const c_void,
93 pout_len: *mut size_t,
98 const LZ_NORM: c_int = 0x80; // LZ with 128 probes, "normal"
99 const TINFL_FLAG_PARSE_ZLIB_HEADER: c_int = 0x1; // parse zlib header and adler32 checksum
100 const TDEFL_WRITE_ZLIB_HEADER: c_int = 0x01000; // write zlib header and adler32 checksum
102 fn deflate_bytes_internal(bytes: &[u8], flags: c_int) -> Bytes {
104 let mut outsz: size_t = 0;
105 let res = tdefl_compress_mem_to_heap(bytes.as_ptr() as *const _,
106 bytes.len() as size_t,
109 assert!(!res.is_null());
111 ptr: Unique::new(res as *mut u8),
117 /// Compress a buffer, without writing any sort of header on the output.
118 pub fn deflate_bytes(bytes: &[u8]) -> Bytes {
119 deflate_bytes_internal(bytes, LZ_NORM)
122 /// Compress a buffer, using a header that zlib can understand.
123 pub fn deflate_bytes_zlib(bytes: &[u8]) -> Bytes {
124 deflate_bytes_internal(bytes, LZ_NORM | TDEFL_WRITE_ZLIB_HEADER)
127 fn inflate_bytes_internal(bytes: &[u8], flags: c_int) -> Result<Bytes, Error> {
129 let mut outsz: size_t = 0;
130 let res = tinfl_decompress_mem_to_heap(bytes.as_ptr() as *const _,
131 bytes.len() as size_t,
136 ptr: Unique::new(res as *mut u8),
145 /// Decompress a buffer, without parsing any sort of header on the input.
146 pub fn inflate_bytes(bytes: &[u8]) -> Result<Bytes, Error> {
147 inflate_bytes_internal(bytes, 0)
150 /// Decompress a buffer that starts with a zlib header.
151 pub fn inflate_bytes_zlib(bytes: &[u8]) -> Result<Bytes, Error> {
152 inflate_bytes_internal(bytes, TINFL_FLAG_PARSE_ZLIB_HEADER)
157 #![allow(deprecated)]
158 use super::{inflate_bytes, deflate_bytes};
159 use std::__rand::{thread_rng, Rng};
162 fn test_flate_round_trip() {
163 let mut r = thread_rng();
164 let mut words = vec![];
166 let range = r.gen_range(1, 10);
167 let v = r.gen_iter::<u8>().take(range).collect::<Vec<u8>>();
171 let mut input = vec![];
173 input.push_all(r.choose(&words).unwrap());
175 debug!("de/inflate of {} bytes of random word-sequences",
177 let cmp = deflate_bytes(&input);
178 let out = inflate_bytes(&cmp).unwrap();
179 debug!("{} bytes deflated to {} ({:.1}% size)",
182 100.0 * ((cmp.len() as f64) / (input.len() as f64)));
183 assert_eq!(&*input, &*out);
188 fn test_zlib_flate() {
189 let bytes = vec![1, 2, 3, 4, 5];
190 let deflated = deflate_bytes(&bytes);
191 let inflated = inflate_bytes(&deflated).unwrap();
192 assert_eq!(&*inflated, &*bytes);