1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

//! Bzip compression for Rust
//!
//! This library contains bindings to libbz2 to support bzip compression and
//! decompression for Rust. The streams offered in this library are primarily
//! found in the `reader` and `writer` modules. Both compressors and
//! decompressors are available in each module depending on what operation you
//! need.
//!
//! Access to the raw decompression/compression stream is also provided through
//! the `raw` module which has a much closer interfact to libbz2.
//!
//! # Example
//!
//! ```
//! # #![allow(unstable)]
//! use std::io::prelude::*;
//! use bzip2::Compress;
//! use bzip2::reader::{BzCompressor, BzDecompressor};
//!
//! // Round trip some bytes from a byte source, into a compressor, into a
//! // decompressor, and finally into a vector.
//! let data = "Hello, World!".as_bytes();
//! let compressor = BzCompressor::new(data, Compress::Best);
//! let mut decompressor = BzDecompressor::new(compressor);
//!
//! let mut contents = String::new();
//! decompressor.read_to_string(&mut contents).unwrap();
//! assert_eq!(contents, "Hello, World!");
//! ```

#![deny(missing_docs)]
#![cfg_attr(test, deny(warnings))]
#![doc(html_root_url = "http://alexcrichton.com/bzip2-rs")]

extern crate bzip2_sys as ffi;
extern crate libc;

pub mod raw;
pub mod writer;
pub mod reader;

use std::io::prelude::*;

/// Compress a block of input data into a bzip2 encoded output vector.
pub fn compress(data: &[u8], level: Compress) -> Vec<u8> {
    let mut wr = writer::BzCompressor::new(Vec::new(), level);
    wr.write_all(data).unwrap();
    wr.into_inner().ok().unwrap()
}

/// Decompress a block of compressed input data into a raw output vector.
pub fn decompress(data: &[u8]) -> Vec<u8> {
    let mut wr = writer::BzDecompressor::new(Vec::new());
    wr.write_all(data).unwrap();
    wr.into_inner().ok().unwrap()
}

/// When compressing data, the compression level can be specified by a value in
/// this enum.
#[derive(Copy, Clone)]
pub enum Compress {
    /// Optimize for the best speed of encoding.
    Fastest = 1,
    /// Optimize for the size of data being encoded.
    Best = 9,
    /// Choose the default compression, a balance between speed and size.
    Default = 6,
}