lzokay-rs/README.md

LZ👌-rs

Pure-Rust port of LZ👌, a minimal, MIT-licensed implementation of the LZO compression format.

See the original README for more information.

Features

• MIT-licensed
• Simple compression and decompression routines
• #![no_std] compatible

Usage

See the compress or decompress documentation for reference.

In Cargo.toml:

[dependencies]
lzokay = "2.0"

Or, to only enable certain features:

[dependencies.lzokay]
version = "2.0"
default-features = false
features = ["decompress", "compress"]

• decompress: Enables decompression functions.
• compress: Enables compression functions.
• alloc: Enables optional compression functions that perform heap allocation. Without std, this uses extern crate alloc.
• std: Enables use of std. Implies alloc.

All features are enabled by default.

License

LZ👌 and LZ👌-rs are available under the MIT License and have no external dependencies.