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

lzfse

Rust bindings for the LZFSE reference implementation

2 unstable releases

Uses old Rust 2015

0.2.0 Nov 14, 2024
0.1.0 Jul 26, 2020

#304 in Compression

Download history 44/week @ 2024-11-21 68/week @ 2024-11-28 358/week @ 2024-12-05 362/week @ 2024-12-12 62/week @ 2024-12-19 37/week @ 2024-12-26 271/week @ 2025-01-02 242/week @ 2025-01-09 300/week @ 2025-01-16 437/week @ 2025-01-23 263/week @ 2025-01-30 270/week @ 2025-02-06 481/week @ 2025-02-13 337/week @ 2025-02-20 270/week @ 2025-02-27 403/week @ 2025-03-06

1,565 downloads per month
Used in dmgwiz

MIT license

145KB
2.5K SLoC

C 2.5K SLoC // 0.3% comments Rust 260 SLoC // 0.1% comments Shell 6 SLoC

lzfse-rs

Build and Testcrates.io

https://img.shields.io/crates/v/lzfse

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

Documentation

# Cargo.toml
[dependencies]
lzfse = "0.2.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]);

Scratch Buffer Example

The encode_buffer_scratch and decode_buffer_scratch functions allow for encoding and decoding using a scratch buffer to avoid allocations by the underlying library. This makes it possible to use the Rust crate with no_std and a custom allocator.

use lzfse::{encode_buffer_scratch, decode_buffer_scratch, Scratch};

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];

let mut compressed = vec![0; input.len() + 12];
let mut scratch = Scratch::new();

let bytes_out = encode_buffer_scratch(&input, &mut compressed, &mut scratch).unwrap();
assert!(bytes_out < input.len());

let mut uncompressed = vec![0; input.len() + 1];
let bytes_in = decode_buffer_scratch(&compressed[0..bytes_out], &mut uncompressed, &mut scratch).unwrap();

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

Dependencies

~0–310KB