[][src]Crate lz4_flex

Pure Rust, high performance implementation of LZ4 compression.

A detailed explanation of the algorithm can be found here.

Examples

use lz4_flex::{compress_prepend_size, decompress_size_prepended};
let input: &[u8] = b"Hello people, what's up?";
let compressed = compress_prepend_size(input);
let uncompressed = decompress_size_prepended(&compressed).unwrap();
assert_eq!(input, uncompressed);

Feature Flags

There are two feature flags: safe-encode and safe-decode.

safe-decode is enabled by default. Currently it adds more checks to the unsafe code, but it still uses unsafe.

safe-encode will switch the compression to completely safe rust code.

Re-exports

pub use block::compress::compress;
pub use block::compress::compress_into;
pub use block::compress::compress_prepend_size;
pub use block::decompress::decompress;
pub use block::decompress::decompress_into;
pub use block::decompress::decompress_size_prepended;

Modules

block

https://github.com/lz4/lz4/blob/dev/doc/lz4_Block_format.md