#lzma #decompression

lzma-rs

A codec for LZMA, LZMA2 and XZ written in pure Rust

7 releases

0.3.0 Jan 4, 2023
0.2.0 May 2, 2021
0.1.4 May 2, 2021
0.1.3 May 5, 2020
0.1.0 Jan 7, 2018

#30 in Compression

Download history 8435/week @ 2023-06-08 8451/week @ 2023-06-15 8830/week @ 2023-06-22 6973/week @ 2023-06-29 10575/week @ 2023-07-06 7811/week @ 2023-07-13 8567/week @ 2023-07-20 6659/week @ 2023-07-27 6950/week @ 2023-08-03 6151/week @ 2023-08-10 8152/week @ 2023-08-17 7728/week @ 2023-08-24 7292/week @ 2023-08-31 7180/week @ 2023-09-07 6653/week @ 2023-09-14 6844/week @ 2023-09-21

29,738 downloads per month
Used in 49 crates (28 directly)

MIT license

125KB
3K SLoC

lzma-rs

Crate Documentation Safety Dance Build Status Minimum rust 1.50 Codecov

This project is a decoder for LZMA and its variants written in pure Rust, with focus on clarity. It already supports LZMA, LZMA2 and a subset of the .xz file format.

Usage

Decompress a .xz file.

let filename = "foo.xz";
let mut f = std::io::BufReader::new(std::fs::File::open(filename).unwrap());
// "decomp" can be anything that implements "std::io::Write"
let mut decomp: Vec<u8> = Vec::new();
lzma_rs::xz_decompress(&mut f, &mut decomp).unwrap();
// Decompressed content is now in "decomp"

Encoder

For now, there is also a dumb encoder that only uses byte literals, with many hard-coded constants for code simplicity. Better encoders are welcome!

Contributing

Pull-requests are welcome, to improve the decoder, add better encoders, or more tests. Ultimately, this project should also implement .xz and .7z files.

License

MIT

Dependencies

~0.1–1MB
~15K SLoC