30 releases (8 stable)

2.0.0 Dec 6, 2024
1.1.0 Jul 7, 2024
1.0.5 Mar 16, 2024
1.0.4 Oct 26, 2022
0.4.1 Jul 31, 2020

#17 in Compression

Download history 4945/week @ 2024-10-30 4921/week @ 2024-11-06 8131/week @ 2024-11-13 6828/week @ 2024-11-20 5184/week @ 2024-11-27 7178/week @ 2024-12-04 8842/week @ 2024-12-11 5135/week @ 2024-12-18 3242/week @ 2024-12-25 7807/week @ 2025-01-01 8890/week @ 2025-01-08 9961/week @ 2025-01-15 10794/week @ 2025-01-22 10789/week @ 2025-01-29 11124/week @ 2025-02-05 8204/week @ 2025-02-12

43,227 downloads per month
Used in 19 crates (11 directly)

MIT license

480KB
9K SLoC

C 6K SLoC // 0.2% comments Rust 3K SLoC // 0.0% comments Visual Studio Project 182 SLoC Visual Studio Solution 25 SLoC
lzzzz

Full-featured liblz4 binding for Rust

Crates.io GitHub license Rustdoc Rust


About

Rust APIs for the LZ4 compression algorithm.

  • Supports almost all liblz4 features
  • Zero dependencies except liblz4
  • Tested on Windows / macOS / Linux

Usage

Add this to your Cargo.toml:

[dependencies]
lzzzz = "1.0.3"

API Documentation

Features

  • LZ4
    • Compression (Block / Streaming)
    • Decompression (Block / Streaming)
    • Partial Decompression
    • Custom Dictionary
  • LZ4_HC
    • Compression (Block / Streaming)
    • Partial Compression
    • Custom Dictionary
  • LZ4F
    • Compression
    • Decompression
    • Custom Dictionary
    • Streaming I/O (Read / BufRead / Write)

Examples

Block Mode

use lzzzz::{lz4, lz4_hc, lz4f};

let data = b"The quick brown fox jumps over the lazy dog.";

// LZ4 compression
let mut comp = Vec::new();
lz4::compress_to_vec(data, &mut comp, lz4::ACC_LEVEL_DEFAULT)?;

// LZ4_HC compression
let mut comp = Vec::new();
lz4_hc::compress_to_vec(data, &mut comp, lz4_hc::CLEVEL_DEFAULT)?;

// LZ4/LZ4_HC decompression
let mut decomp = vec![0; data.len()];
lz4::decompress(&comp, &mut decomp)?;

// LZ4F compression
let prefs = lz4f::Preferences::default();
let mut comp = Vec::new();
lz4f::compress_to_vec(data, &mut comp, &prefs)?;

// LZ4F decompression
let mut decomp = Vec::new();
lz4f::decompress_to_vec(&comp, &mut decomp)?;

Streaming Mode

use lzzzz::{lz4, lz4_hc};

let data = b"The quick brown fox jumps over the lazy dog.";

// LZ4 compression
let mut comp = lz4::Compressor::new()?;
let mut buf = Vec::new();
comp.next_to_vec(data, &mut buf, lz4::ACC_LEVEL_DEFAULT)?;

// LZ4_HC compression
let mut comp = lz4_hc::Compressor::new()?;
let mut buf = Vec::new();
comp.next_to_vec(data, &mut buf)?;

// LZ4/LZ4_HC decompression
let mut decomp = lz4::Decompressor::new()?;
let result = decomp.next(&data, data.len())?;
use lzzzz::lz4f::{WriteCompressor, ReadDecompressor, Preferences};
use std::{fs::File, io::prelude::*};

// LZ4F Write-based compression
let mut f = File::create("foo.lz4")?;
let mut w = WriteCompressor::new(&mut f, Preferences::default())?;
w.write_all(b"Hello world!")?;

// LZ4F Read-based decompression
let mut f = File::open("foo.lz4")?;
let mut r = ReadDecompressor::new(&mut f)?;
let mut buf = Vec::new();
r.read_to_end(&mut buf)?;

No runtime deps

~0–315KB