lzma-rs

Crates.iolzma-rs
lib.rslzma-rs
version0.3.0
sourcesrc
created_at2018-01-07 21:59:22.160891
updated_at2023-01-04 00:34:47.136594
descriptionA codec for LZMA, LZMA2 and XZ written in pure Rust
homepage
repositoryhttps://github.com/gendx/lzma-rs
max_upload_size
id45882
size129,283
Guillaume E (gendx)

documentation

README

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

Commit count: 216

cargo fmt