8 unstable releases (3 breaking)
new 0.5.3+496255c | Oct 15, 2024 |
---|---|
0.5.2+496255c | Oct 5, 2024 |
0.4.0+496255c | Sep 26, 2024 |
0.3.1+496255c | Sep 24, 2024 |
0.2.0+496255c | Sep 22, 2024 |
#147 in Compression
4,611 downloads per month
Used in libcramjam
4MB
79K
SLoC
isal-rs
Rust bindings for isa-l
Supports the following codecs using the ISA-L library under the hood:
- GZIP
isal::read::GzipEncoder/GzipDecoder
isal::write::GzipEncoder/GzipDecoder
- DEFLATE
isal::read::DeflateEncoder/DeflateDecoder
isal::write::DeflateEncoder/DeflateDecoder
- ZLIB
isal::read::ZlibEncoder/ZlibDecoder
isal::write::ZlibEncoder/ZlibDecoder
Or can use functions of de/compress
and de/compress_into
Building requires some system tools like autotools
, nasm
, make
, and anything the official ISA-L repo suggests.
On Windows the build is invoked with nmake
, other systems use the ./autogen.sh
and ./configure
setups.
Examples:
Functions like compress_into
and decompress
(Similar functionality with compress
and decompress_into
)
use isal::{CompressionLevel, Codec, compress_into, decompress};
let mut compressed = vec![0u8; 100];
let nbytes = compress_into(b"foobar", &mut compressed, CompressionLevel::Three, Codec::Gzip).unwrap();
let decompressed = decompress(&compressed[..nbytes], Codec::Gzip).unwrap();
assert_eq!(decompressed.as_slice(), b"foobar");
Compress using the Encoder/Decoder structs implementing io::Read
use std::{io, io::Read};
use isal::{read::{Encoder, GzipEncoder}, CompressionLevel, decompress, Codec};
let data = b"Hello, World!".to_vec();
// Note these two encoders are equivelent...
let mut encoder = GzipEncoder::new(data.as_slice(), CompressionLevel::Three);
let mut encoder = Encoder::new(data.as_slice(), CompressionLevel::Three, Codec::Gzip);
// Number of compressed bytes written to `output`
let mut compressed = vec![];
let n = io::copy(&mut encoder, &mut compressed).unwrap();
assert_eq!(n as usize, compressed.len());
let decompressed = decompress(compressed.as_slice(), Codec::Gzip).unwrap();
assert_eq!(decompressed.as_slice(), data);
Decompress using the Encoder/Decoder structs implementing io::Write
use std::{io, io::Write};
use isal::{write::Decoder, CompressionLevel, compress, Codec};
let data = b"Hello, World!".to_vec();
let compressed = compress(data.as_slice(), CompressionLevel::Three, Codec::Gzip).unwrap();
let mut decompressed = vec![];
let mut decoder = Decoder::new(&mut decompressed, Codec::Gzip);
// Number of compressed bytes written to `output`
let n = io::copy(&mut io::Cursor::new(&compressed), &mut decoder).unwrap();
assert_eq!(n as usize, compressed.len());
assert_eq!(decompressed.as_slice(), data);
Benchmarks
TL/DR: It's roughly 5-10x faster on average than the default settings with flate2.
Checkout the README in the benches directory. Criterion benchmark report available here: https://milesgranger.github.io/isal-rs/benches/criterion/report/
Versioning:
Versions are specified in normal SemVer format, and a trailing "+<< commit hash >>
" to indicate
which commit in isa-l the crate is built against. ie: 0.1.0+62519d9