maclarian 0.1.3

Larian file format library for Baldur's Gate 3 - PAK, LSF, LSX, GR2, DDS, and more
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! Compression utilities

use crate::error::{Error, Result};

// Internal compression backends (not public API)
pub(crate) mod fastlz;
pub(crate) mod lz4;

/// Compress data using LZ4
///
/// # Errors
/// Returns an error if compression fails.
pub fn compress(data: &[u8]) -> Result<Vec<u8>> {
    Ok(lz4_flex::compress_prepend_size(data))
}

/// Decompress LZ4 data
///
/// # Errors
/// Returns an error if decompression fails.
pub fn decompress(data: &[u8], decompressed_size: usize) -> Result<Vec<u8>> {
    lz4_flex::decompress(data, decompressed_size).map_err(|e| Error::Lz4DecompressionFailed {
        message: e.to_string(),
    })
}

/// Decompress LZ4 data with size prepended
///
/// # Errors
/// Returns an error if decompression fails.
pub fn decompress_with_size(data: &[u8]) -> Result<Vec<u8>> {
    lz4_flex::decompress_size_prepended(data).map_err(|e| Error::Lz4DecompressionFailed {
        message: e.to_string(),
    })
}