Fastest LZ4 implementation in Rust. Originally based on redox-os' lz4 compression, but now a complete rewrite. The results in the table are from a benchmark in this project (66Kb JSON).
| Compressor | Compression | Decompression | Ratio | |----------------------|-------------|---------------|---------------| | lz4flex unsafe | 947 MiB/s | 5017 MiB/s | 0.2270 | | lz4flex safe | 649 MiB/s | 1433 MiB/s | 0.2270 | | lz4rs (lz4 1.8.1) | 1001 MiB/s | 4627 MiB/s | 0.2283 | | lz4fear | 456 MiB/s | 809 MiB/s | 0.2283 |
Compression and decompression uses no usafe via the default feature flags "safe-encode" and "safe-decode". If you need more performance you can disable them (e.g. with no-default-features).
Safe:
lz4_flex = { version = "0.7.5" }
Performance:
lz4_flex = { version = "0.7.5", default-features = false }
Warning: If you don't trust your input, use checked-decode in order to avoid out of bounds access.
lz4_flex = { version = "0.7.5", default-features = false, features = ["checked-decode"] }
```rust use lz4flex::{compressprependsize, decompresssize_prepended};
fn main(){ let input: &[u8] = b"Hello people, what's up?"; let compressed = compressprependsize(input); let uncompressed = decompresssizeprepended(&compressed).unwrap(); assert_eq!(input, uncompressed); } ```
The benchmark is run with criterion, the test files are in the benches folder.
Currently 3 implementations are compared, this one, the redox-version, lz-fear and the c++ version via rust bindings. The lz4-flex version is tested with the feature flags safe-decode and safe-encode switched on and off.
cargo bench --no-default-features
Executed on Core i7-6700 Linux Mint.
cargo bench
Executed on Core i7-6700 Linux Mint.
Miri can be used to find issues related to incorrect unsafe usage:
MIRIFLAGS="-Zmiri-disable-isolation -Zmiri-disable-stacked-borrows" cargo miri test --no-default-features
This fuzz target generates corrupted data for the decompressor. Make sure to switch to the checked_decode version in fuzz/Cargo.toml before testing this.
cargo fuzz run fuzz_decomp_corrupted_data
This fuzz target asserts that a compression and decompression rountrip returns the original input.
cargo fuzz run fuzz_roundtrip
This fuzz target asserts compression with cpp and decompression with lz4_flex returns the original input.
cargo fuzz run fuzz_roundtrip_cpp_compress