#reference #bindings #api-bindings #byte #input

lzfse

Rust bindings for the LZFSE reference implementation

1 unstable release

Uses old Rust 2015

0.1.0 Jul 26, 2020

#341 in #reference

Download history 6/week @ 2024-01-29 28/week @ 2024-02-19 16/week @ 2024-02-26 4/week @ 2024-03-04 22/week @ 2024-03-11 5/week @ 2024-03-18 3/week @ 2024-03-25 40/week @ 2024-04-01

71 downloads per month
Used in dmgwiz

MIT license

135KB
2.5K SLoC

C 2.5K SLoC // 0.3% comments Rust 118 SLoC // 0.1% comments

lzfse-rs

Rust bindings for the LZFSE reference implementation at https://github.com/lzfse/lzfse.

Documentation

# Cargo.toml
[dependencies]
lzfse = "0.1.0"

lib.rs:

Rust bindings for the LZFSE reference implementation

https://github.com/lzfse/lzfse

Example

use lzfse::{decode_buffer, encode_buffer};

let input: &[u8] = &[0xF, 0xE, 0xE, 0xD, 0xF, 0xA, 0xC, 0xE,
                     0xF, 0xE, 0xE, 0xD, 0xF, 0xA, 0xC, 0xE,
                     0xF, 0xE, 0xE, 0xD, 0xF, 0xA, 0xC, 0xE,
                     0xF, 0xE, 0xE, 0xD, 0xF, 0xA, 0xC, 0xE,
                     0xF, 0xE, 0xE, 0xD, 0xF, 0xA, 0xC, 0xE,
                     0xF, 0xE, 0xE, 0xD, 0xF, 0xA, 0xC, 0xE];

// compression
// in the worst case lzfse will fallback to return the input uncompressed
// and add a magic header to indicate this. that requires 12 bytes (see lzfse_encode.c)
let max_outlen = input.len() + 12;
let mut compressed = vec![0; max_outlen];

let bytes_out = encode_buffer(&input[..], &mut compressed[..]).unwrap();
assert!(bytes_out < input.len());

// decompression
// need to allocate 1 byte more since lzfse returns input.len() if the buffer is too small
let mut uncompressed = vec![0; input.len() + 1];
let bytes_in = decode_buffer(&compressed[0..bytes_out], &mut uncompressed[..]).unwrap();

assert_eq!(bytes_in, input.len());
assert_eq!(input[..], uncompressed[..bytes_in]);

Dependencies

~215KB