lz4r 1.10.0

LZ4 CLI programs — Rust port of lz4-1.10.0/programs
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

//! `lz4r` — a pure-Rust implementation of the LZ4 compression algorithms and
//! command-line programs (equivalent to the `programs/` tree of LZ4 v1.10.0).
//!
//! # Crate layout
//!
//! | Module       | Contents |
//! |--------------|----------|
//! | `block`      | Low-level block compression and decompression (LZ4 spec §§ 1–3). |
//! | `frame`      | LZ4 Frame format (magic number, header, content checksum). |
//! | `hc`         | High-compression (`lz4hc`) encoder variants. |
//! | `io`         | File-level I/O: compress / decompress single and multiple files. |
//! | `file`       | Streaming `Read`/`Write` wrappers over the Frame API. |
//! | `cli`        | Command-line argument parsing and dispatch. |
//! | `bench`      | Throughput benchmarking infrastructure. |
//! | `xxhash`     | XXH32 content-checksum wrapper. |
//! | `lorem`      | Deterministic lorem ipsum generator (benchmark corpus). |
//! | `timefn`     | Monotonic high-resolution timer. |
//! | `threadpool` | Fixed-size work-stealing thread pool. |
//! | `config`     | Compile-time configuration constants. |
//! | `util`       | File enumeration and sizing utilities. |

pub mod config;
pub mod lorem;
pub mod timefn;

#[cfg(feature = "c-abi")]
pub mod abi;
pub mod bench;
pub mod block;
pub mod cli;
pub mod file;
pub mod frame;
pub mod hc;
pub mod io;
pub mod threadpool;
pub mod util;
pub mod xxhash;

// ── Version constants (mirrors lz4.h lines 131–143) ──────────────────────────
pub const LZ4_VERSION_MAJOR: u32 = 1;
pub const LZ4_VERSION_MINOR: u32 = 10;
pub const LZ4_VERSION_RELEASE: u32 = 0;
pub const LZ4_VERSION_NUMBER: u32 =
    LZ4_VERSION_MAJOR * 100 * 100 + LZ4_VERSION_MINOR * 100 + LZ4_VERSION_RELEASE;
pub const LZ4_VERSION_STRING: &str = "1.10.0";
/// Git commit hash string injected at build time via the `LZ4_GIT_COMMIT`
/// environment variable.  Empty when the variable is not set.
pub const LZ4_GIT_COMMIT_STRING: &str = "";

/// Returns the runtime version number (equivalent to LZ4_versionNumber()).
pub fn version_number() -> u32 {
    LZ4_VERSION_NUMBER
}

/// Returns the runtime version string (equivalent to LZ4_versionString()).
pub fn version_string() -> &'static str {
    LZ4_VERSION_STRING
}

// ── Distance / inplace constants ──────────────────────────────────────────────
pub const LZ4_DISTANCE_MAX: usize = 65_535;
pub const COMPRESS_INPLACE_MARGIN: usize = LZ4_DISTANCE_MAX + 32;

/// Returns the size in bytes of the internal stream state (LZ4_sizeofState()).
pub fn size_of_state() -> i32 {
    core::mem::size_of::<block::types::StreamStateInternal>() as i32
}

/// Margin required for in-place decompression (lz4.h line 670).
pub fn decompress_inplace_margin(compressed_size: usize) -> usize {
    (compressed_size >> 8) + 32
}

/// Minimum buffer size for in-place decompression (lz4.h line 672).
pub fn decompress_inplace_buffer_size(decompressed_size: usize) -> usize {
    decompressed_size + decompress_inplace_margin(decompressed_size)
}

/// Minimum buffer size for in-place compression (lz4.h line 678).
pub fn compress_inplace_buffer_size(max_compressed_size: usize) -> usize {
    max_compressed_size + COMPRESS_INPLACE_MARGIN
}

// ── Top-level re-exports ──────────────────────────────────────────────────────
pub use block::compress::compress_default as lz4_compress_default;
pub use block::decompress_api::decompress_safe as lz4_decompress_safe;

// Block API — one-shot compression (needed by e2e tests)
pub use block::{
    compress_bound, compress_dest_size, compress_fast, decompress_safe_partial,
    decompress_safe_using_dict, Lz4Error, LZ4_ACCELERATION_DEFAULT, LZ4_ACCELERATION_MAX,
    LZ4_MAX_INPUT_SIZE,
};

// Error types
pub use block::decompress_core::DecompressError;

// Frame API convenience re-exports
pub use frame::{lz4f_compress_frame, lz4f_decompress};