prs-rs 2.0.3

High performance compressor/decompressor for the SEGA PRS Compression scheme
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use crate::prelude::{Allocator, Global};

use crate::{
    impls::comp::{
        comp_dict::{CompDict, MaxOffset},
        compress::prs_compress,
    },
    MutablePointerSrc,
};

/// BENCHMARK ONLY, DO NOT USE
#[doc(hidden)]
pub fn create_comp_dict(data: &[u8]) -> MaxOffset {
    unsafe {
        let mut dict = CompDict::new(data.len());
        dict.init(data, 0);
        dict.get_item(0, 0, u32::MAX as usize)[0]
    }
}

/// Compresses the given data in `source`, placing it in `destimation`.
///
/// Parameters
///
/// - `src`: A pointer to the decompressed data.
/// - `src_len`: Length of the decompressed data.
/// - `destination`: A pointer to the compressed data to be written.
///
/// # Returns
///
/// Number of bytes written to `destination`.
///
/// # Safety
///
/// It's safe as long as `dest` has sufficient length (max length: [`crate::util::prs_calculate_max_compressed_size`])
/// and the remaining parameters are valid.
pub unsafe fn prs_compress_unsafe<T: MutablePointerSrc>(
    src: *const u8,
    src_len: usize,
    mut dest: T,
) -> usize {
    prs_compress::<Global, Global>(src, dest.as_mut_ptr(), src_len, Global, Global)
}

/// Compresses the given data in `source`, placing it in `destimation`.
/// Uses a custom allocator for short and long lived memory.
///
/// Parameters
///
/// - `src`: A pointer to the decompressed data.
/// - `src_len`: Length of the decompressed data.
/// - `destination`: A pointer to the compressed data to be written.
/// - `long_lived_allocator`: The allocator to use for long-lived memory allocation.
/// - `short_lived_allocator`: The allocator to use for short-lived memory allocation.
///
/// # Returns
///
/// Number of bytes written to `destination`.
///
/// # Safety
///
/// It's safe as long as `dest` has sufficient length (max length: [`crate::util::prs_calculate_max_compressed_size`])
/// and the remaining parameters are valid.
pub unsafe fn prs_compress_unsafe_with_allocator<
    T: MutablePointerSrc,
    L: Allocator + Copy,
    S: Allocator + Copy,
>(
    src: *const u8,
    src_len: usize,
    mut dest: T,
    long_lived_allocator: L,
    short_lived_allocator: S,
) -> usize {
    prs_compress::<L, S>(
        src,
        dest.as_mut_ptr(),
        src_len,
        long_lived_allocator,
        short_lived_allocator,
    )
}