bunko 0.1.1

bunko is a lightweight, flexible, high-performance Rust library for data compression and decompression.
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
use flate2::{
    write::{GzEncoder, GzDecoder, DeflateEncoder, DeflateDecoder, ZlibEncoder, ZlibDecoder},
    Compression,
};
use flate2::read::{DeflateEncoder as RawDeflateEncoder, DeflateDecoder as RawDeflateDecoder};
use std::io::{Read, Write};
use serde::{Deserialize, Serialize};
use bincode;

/// Bunko custom error handling.
#[derive(Debug)]
pub enum BunkoError {
    CompressionError(String),
    DecompressionError(String),
    Utf8Error(String),
    SerializationError(String),
    DeserializationError(String),
}

impl std::fmt::Display for BunkoError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{:?}", self)
    }
}

impl std::error::Error for BunkoError {}

impl From<std::string::FromUtf8Error> for BunkoError {
    fn from(err: std::string::FromUtf8Error) -> Self {
        BunkoError::Utf8Error(err.to_string())
    }
}

/// Supported compression formats.
pub enum CompressionFormat {
    Gzip,
    Deflate,
    Zlib,
}

/// Supported compression levels.
pub enum CompressionLevel {
    Fastest,
    Default,
    Best,
}

impl CompressionLevel {
    /// Maps the custom `CompressionLevel` enum to the `flate2::Compression` enum.
    ///
    /// Returns:
    /// - `flate2::Compression::fast()` for `Fastest`
    /// - `flate2::Compression::default()` for `Default`
    /// - `flate2::Compression::best()` for `Best`
    fn to_flate2_compression(&self) -> Compression {
        match self {
            CompressionLevel::Fastest => Compression::fast(),
            CompressionLevel::Default => Compression::default(),
            CompressionLevel::Best => Compression::best(),
        }
    }
}

/// Compresses a byte slice using the specified format and compression level.
///
/// # Parameters
/// - `input`: The byte slice to be compressed.
/// - `format`: The compression format to use (`Gzip`, `Deflate`, or `Zlib`).
/// - `level`: The compression level to apply (`Fastest`, `Default`, or `Best`).
///
/// # Returns
/// A `Result` containing the compressed data as a `Vec<u8>` on success, or a `String` with an error message on failure.
pub fn compress(
    input: &[u8],
    format: CompressionFormat,
    level: CompressionLevel,
) -> Result<Vec<u8>, String> {
    let compression = level.to_flate2_compression();

    match format {
        CompressionFormat::Gzip => {
            let mut encoder = GzEncoder::new(Vec::new(), compression);
            encoder
                .write_all(input)
                .map_err(|e| format!("Compression error: {}", e))?;
            encoder
                .finish()
                .map_err(|e| format!("Failed to finish compression: {}", e))
        }
        CompressionFormat::Deflate => {
            let mut encoder = DeflateEncoder::new(Vec::new(), compression);
            encoder
                .write_all(input)
                .map_err(|e| format!("Compression error: {}", e))?;
            encoder
                .finish()
                .map_err(|e| format!("Failed to finish compression: {}", e))
        }
        CompressionFormat::Zlib => {
            let mut encoder = ZlibEncoder::new(Vec::new(), compression);
            encoder
                .write_all(input)
                .map_err(|e| format!("Compression error: {}", e))?;
            encoder
                .finish()
                .map_err(|e| format!("Failed to finish compression: {}", e))
        }
    }
}

/// Decompresses a byte slice using the specified format.
///
/// # Parameters
/// - `input`: The byte slice to be decompressed.
/// - `format`: The compression format used (`Gzip`, `Deflate`, or `Zlib`).
///
/// # Returns
/// A `Result` containing the decompressed data as a `Vec<u8>` on success, or a `String` with an error message on failure.
pub fn decompress(input: &[u8], format: CompressionFormat) -> Result<Vec<u8>, String> {
    match format {
        CompressionFormat::Gzip => {
            let mut decoder = GzDecoder::new(Vec::new());
            decoder
                .write_all(input)
                .map_err(|e| format!("Decompression error: {}", e))?;
            decoder
                .finish()
                .map_err(|e| format!("Failed to finish decompression: {}", e))
        }
        CompressionFormat::Deflate => {
            let mut decoder = DeflateDecoder::new(Vec::new());
            decoder
                .write_all(input)
                .map_err(|e| format!("Decompression error: {}", e))?;
            decoder
                .finish()
                .map_err(|e| format!("Failed to finish decompression: {}", e))
        }
        CompressionFormat::Zlib => {
            let mut encoder = ZlibDecoder::new(Vec::new());
            encoder
                .write_all(input)
                .map_err(|e| format!("Compression error: {}", e))?;
            encoder
                .finish()
                .map_err(|e| format!("Failed to finish compression: {}", e))
        }
    }
}

/// Compresses raw Deflate data.
///
/// # Parameters
/// - `input`: The byte slice to be compressed.
/// - `level`: The compression level to apply (`Fastest`, `Default`, or `Best`).
///
/// # Returns
/// A `Result` containing the compressed data as a `Vec<u8>` on success, or a `BunkoError::CompressionError` on failure.

pub fn compress_raw(input: &[u8], level: CompressionLevel) -> Result<Vec<u8>, BunkoError> {
    let compression = level.to_flate2_compression();
    let mut encoder = RawDeflateEncoder::new(input, compression);
    let mut compressed = Vec::new();
    encoder
        .read_to_end(&mut compressed)
        .map_err(|e| BunkoError::CompressionError(e.to_string()))?;
    Ok(compressed)
}

/// Decompresses raw Deflate data.
///
/// # Parameters
/// - `input`: The byte slice to be decompressed.
///
/// # Returns
/// A `Result` containing the decompressed data as a `Vec<u8>` on success, or a `BunkoError::DecompressionError` on failure.

pub fn decompress_raw(input: &[u8]) -> Result<Vec<u8>, BunkoError> {
    let mut decoder = RawDeflateDecoder::new(input);
    let mut decompressed = Vec::new();
    decoder
        .read_to_end(&mut decompressed)
        .map_err(|e| BunkoError::DecompressionError(e.to_string()))?;
    Ok(decompressed)
}

/// Compresses a serializable Rust struct.
///
/// # Parameters
/// - `data`: A reference to the data structure to be compressed.
/// - `format`: The compression format to use (`Gzip`, `Deflate`, or `Zlib`).
/// - `level`: The compression level to apply (`Fastest`, `Default`, or `Best`).
///
/// # Returns
/// A `Result` containing the compressed data as a `Vec<u8>` on success, or a `BunkoError` on failure.

pub fn compress_struct<T: Serialize>(
    data: &T,
    format: CompressionFormat,
    level: CompressionLevel,
) -> Result<Vec<u8>, BunkoError> {
    let serialized = bincode::serialize(data).map_err(|e| BunkoError::SerializationError(e.to_string()))?;
    compress(&serialized, format, level).map_err(BunkoError::CompressionError)
}

/// Decompresses a byte slice into a Rust struct.
///
/// # Parameters
/// - `compressed_data`: The byte slice to be decompressed.
/// - `format`: The compression format used (`Gzip`, `Deflate`, or `Zlib`).
///
/// # Returns
/// A `Result` containing the deserialized struct on success, or a `BunkoError` on failure.

pub fn decompress_struct<T: for<'de> Deserialize<'de>>(
    compressed_data: &[u8],
    format: CompressionFormat,
) -> Result<T, BunkoError> {
    // Decompress the input
    let decompressed = decompress(compressed_data, format).map_err(BunkoError::DecompressionError)?;

    // Deserialize the decompressed data into the desired type
    bincode::deserialize(&decompressed).map_err(|e| BunkoError::DeserializationError(e.to_string()))
}


/// Compresses data in chunks for streaming use cases.
///
/// # Parameters
/// - `chunks`: A slice of byte slices to be compressed in sequence.
/// - `format`: The compression format to use (`Gzip`, `Deflate`, or `Zlib`).
/// - `level`: The compression level to apply (`Fastest`, `Default`, or `Best`).
///
/// # Returns
/// A `Result` containing the compressed data as a `Vec<u8>` on success, or a `String` with an error message on failure.
pub fn compress_stream(
    chunks: &[&[u8]],
    format: CompressionFormat,
    level: CompressionLevel,
) -> Result<Vec<u8>, String> {
    let compression = level.to_flate2_compression();

    match format {
        CompressionFormat::Gzip => {
            let mut encoder = GzEncoder::new(Vec::new(), compression);
            for chunk in chunks {
                encoder
                    .write_all(chunk)
                    .map_err(|e| format!("Stream compression error: {}", e))?;
            }
            encoder
                .finish()
                
                .map_err(|e| format!("Failed to finish streaming compression: {}", e))
        }
        CompressionFormat::Deflate => {
            let mut encoder = DeflateEncoder::new(Vec::new(), compression);
            for chunk in chunks {
                encoder
                    .write_all(chunk)
                    .map_err(|e| format!("Stream compression error: {}", e))?;
            }
            encoder
                .finish()
                .map_err(|e| format!("Failed to finish streaming compression: {}", e))
        }
        CompressionFormat::Zlib => {
            let mut encoder = ZlibEncoder::new(Vec::new(), compression);
            for chunk in chunks {
                encoder
                    .write_all(chunk)
                    .map_err(|e| format!("Stream compression error: {}", e))?;
            }
            encoder
                .finish()
                .map_err(|e| format!("Failed to finish streaming compression: {}", e))
        }
    }
}

/// Decompresses data in chunks for streaming use cases.
///
/// # Parameters
/// - `chunks`: A slice of byte slices to be decompressed in sequence.
/// - `format`: The compression format used (`Gzip`, `Deflate`, or `Zlib`).
///
/// # Returns
/// A `Result` containing the decompressed data as a `Vec<u8>` on success, or a `String` with an error message on failure.
pub fn decompress_stream(
    chunks: &[&[u8]],
    format: CompressionFormat,
) -> Result<Vec<u8>, String> {
    match format {
        CompressionFormat::Gzip => {
            let mut decoder = GzDecoder::new(Vec::new());
            for chunk in chunks {
                decoder
                    .write_all(chunk)
                    .map_err(|e| format!("Stream decompression error: {}", e))?;
            }
            decoder
                .finish()
                .map_err(|e| format!("Failed to finish streaming decompression: {}", e))
        }
        CompressionFormat::Deflate => {
            let mut decoder = DeflateDecoder::new(Vec::new());
            for chunk in chunks {
                decoder
                    .write_all(chunk)
                    .map_err(|e| format!("Stream decompression error: {}", e))?;
            }
            decoder
                .finish()
                .map_err(|e| format!("Failed to finish streaming decompression: {}", e))
        }
        CompressionFormat::Zlib => {
            let mut decoder = ZlibDecoder::new(Vec::new());
            for chunk in chunks {
                decoder
                    .write_all(chunk)
                    .map_err(|e| format!("Stream decompression error: {}", e))?;
            }
            decoder
                .finish()
                .map_err(|e| format!("Failed to finish streaming decompression: {}", e))
        }
    }
}

/// Compresses data with a specified buffer size.
///
/// # Parameters
/// - `input`: The byte slice to be compressed.
/// - `format`: The compression format to use (`Gzip`, `Deflate`, or `Zlib`).
/// - `level`: The compression level to apply (`Fastest`, `Default`, or `Best`).
/// - `buffer_size`: The size of the buffer for processing chunks of data.
///
/// # Returns
/// A `Result` containing the compressed data as a `Vec<u8>` on success, or a `BunkoError::CompressionError` on failure.

pub fn compress_with_buffer(
    input: &[u8],
    format: CompressionFormat,
    level: CompressionLevel,
    buffer_size: usize,
) -> Result<Vec<u8>, BunkoError> {
    let compression = level.to_flate2_compression();

    match format {
        CompressionFormat::Gzip => {
            let mut encoder = GzEncoder::new(Vec::new(), compression);
            for chunk in input.chunks(buffer_size) {
                encoder
                    .write_all(chunk)
                    .map_err(|e| BunkoError::CompressionError(e.to_string()))?;
            }
            encoder
                .finish()
                .map_err(|e| BunkoError::CompressionError(e.to_string()))
        }
        CompressionFormat::Deflate => {
            let mut encoder = DeflateEncoder::new(Vec::new(), compression);
            for chunk in input.chunks(buffer_size) {
                encoder
                    .write_all(chunk)
                    .map_err(|e| BunkoError::CompressionError(e.to_string()))?;
            }
            encoder
                .finish()
                .map_err(|e| BunkoError::CompressionError(e.to_string()))
        }
        CompressionFormat::Zlib => {
            let mut encoder = ZlibEncoder::new(Vec::new(), compression);
            for chunk in input.chunks(buffer_size) {
                encoder
                    .write_all(chunk)
                    .map_err(|e| BunkoError::CompressionError(e.to_string()))?;
            }
            encoder
                .finish()
                .map_err(|e| BunkoError::CompressionError(e.to_string()))
        }
    }
}

/// Compresses a string using gzip and the specified compression level.
///
/// # Parameters
/// - `input`: The input string to be compressed.
/// - `level`: The compression level to apply (`Fastest`, `Default`, or `Best`).
///
/// # Returns
/// A `Result` containing the compressed data as a `Vec<u8>` on success, or a `String` with an error message on failure.
pub fn compress_string(input: &str, level: CompressionLevel) -> Result<Vec<u8>, String> {
    compress(input.as_bytes(), CompressionFormat::Gzip, level)
}

/// Decompresses gzip-compressed data into a string.
///
/// # Parameters
/// - `compressed_data`: The gzip-compressed byte slice to decompress.
///
/// # Returns
/// A `Result` containing the decompressed string on success, or a `String` with an error message on failure.
pub fn decompress_to_string(compressed_data: &[u8]) -> Result<String, String> {
    let decompressed_data = decompress(compressed_data, CompressionFormat::Gzip)?;
    String::from_utf8(decompressed_data).map_err(|e| format!("UTF-8 error: {}", e))
}

/// Calculates the compression ratio.
///
/// # Parameters
/// - `original_size`: The size of the original uncompressed data.
/// - `compressed_size`: The size of the compressed data.
///
/// # Returns
/// The compression ratio as a floating-point value (e.g., 0.25 means 25% reduction).
/// Returns `0.0` if `original_size` is zero.

pub fn calculate_compression_ratio(original_size: usize, compressed_size: usize) -> f64 {
    if original_size == 0 {
        0.0
    } else {
        1.0 - (compressed_size as f64 / original_size as f64)
    }
}