gzippy 0.8.0

The fastest parallel gzip. Drop-in replacement for gzip and pigz, and a Rust library.
Documentation 
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
70
71
72
73
74
75
76
77
78
79
80
81
82

//! Pure-Rust port of Google Zopfli. Output is pinned to Google's reference
//! implementation by the regression fixtures in `tests.rs`.

pub mod blocksplitter;
pub mod cache;
pub mod deflate;
pub mod deflate_size;
pub mod gzip;
pub mod hash;
pub mod katajainen;
pub mod lz77;
pub mod squeeze;
pub mod symbols;
pub mod tree;
pub mod zlib;

#[cfg(test)]
mod tests;

#[cfg(all(test, feature = "oracle"))]
mod oracle_tests;

/// Compression knobs. The first five fields mirror the *active* knobs in
/// Google Zopfli's `ZopfliOptions`. The C struct also has a sixth field
/// `blocksplittinglast` that the C upstream documents as "No longer used,
/// left for compatibility"; we omit it deliberately — production code
/// never reads it and the corpus-oracle FFI shim in `oracle_tests.rs`
/// declares its own `#[repr(C)]` mirror that matches the full C layout.
/// `thread_budget` is a Rust-only knob that bounds intra-block
/// parallelism so callers with their own outer pool don't oversubscribe
/// (`1` = serial, anything else = one thread per chunk).
#[derive(Clone, Debug)]
pub struct ZopfliOptions {
    pub verbose: i32,
    pub verbose_more: i32,
    pub numiterations: i32,
    pub blocksplitting: i32,
    pub blocksplittingmax: i32,
    pub thread_budget: u32,
}

impl Default for ZopfliOptions {
    fn default() -> Self {
        Self {
            verbose: 0,
            verbose_more: 0,
            numiterations: 15,
            blocksplitting: 1,
            blocksplittingmax: 15,
            thread_budget: 0,
        }
    }
}

/// Output container format. Mirrors C `ZopfliFormat` from `zopfli.h`.
/// `Gzip` and `Zlib` aren't reached from gzippy proper — `ZopfliGzEncoder`
/// writes its own gzip header and calls into the `Deflate` arm — but
/// they stay in the dispatcher because (a) they're the public surface of
/// `zopfli_pure` for any other consumer, and (b) the regression fixtures
/// in `tests` and the Phase 11.2 corpus oracle use them.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ZopfliFormat {
    #[allow(dead_code)]
    Gzip,
    #[allow(dead_code)]
    Zlib,
    Deflate,
}

/// Top-level dispatcher: wraps `in_` in the requested container and
/// returns the compressed bytes. Mirrors C `ZopfliCompress`.
pub fn compress(options: &ZopfliOptions, format: ZopfliFormat, in_: &[u8]) -> Vec<u8> {
    let mut out = Vec::new();
    match format {
        ZopfliFormat::Gzip => gzip::gzip_compress(options, in_, &mut out),
        ZopfliFormat::Zlib => zlib::zlib_compress(options, in_, &mut out),
        ZopfliFormat::Deflate => {
            deflate::deflate(options, 2, true, in_, 0, &mut out);
        }
    }
    out
}