haagenti-brotli 0.1.0

Brotli compression for Haagenti
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
//! # Haagenti Brotli
//!
//! Brotli compression implementation (RFC 7932).
//!
//! Brotli achieves high compression ratios, especially for text and web
//! content, at the cost of slower compression speed.
//!
//! ## Features
//!
//! - **High Ratio**: Excellent compression for text/web content
//! - **Dictionary**: Built-in and custom dictionary support
//! - **Streaming**: Incremental compression/decompression
//! - **Quality Levels**: 0-11 quality settings
//!
//! ## Example
//!
//! ```ignore
//! use haagenti_brotli::BrotliCodec;
//! use haagenti_core::{Codec, Compressor, Decompressor};
//!
//! let codec = BrotliCodec::new();
//! let compressed = codec.compress(data)?;
//! let original = codec.decompress(&compressed)?;
//! ```
//!
//! ## Implementation
//!
//! This crate wraps the `brotli` crate to provide Haagenti trait implementations.
//! A native Rust implementation may be added in the future.

use std::io::{Read, Write};

use haagenti_core::{
    Algorithm, Codec, CompressionLevel, CompressionStats, Compressor, Decompressor, Error, Result,
};

/// Default buffer size for Brotli operations.
const BUFFER_SIZE: usize = 4096;

/// Default window size (log2) for Brotli compression (22 = 4MB window).
const DEFAULT_LG_WIN: u32 = 22;

/// Map CompressionLevel to Brotli quality (0-11).
fn map_quality(level: CompressionLevel) -> u32 {
    match level {
        CompressionLevel::None => 0,
        CompressionLevel::Fast => 1,
        CompressionLevel::Default => 6,
        CompressionLevel::Best => 10,
        CompressionLevel::Ultra => 11,
        CompressionLevel::Custom(l) => (l as u32).clamp(0, 11),
    }
}

/// Brotli compressor.
#[derive(Debug, Clone)]
pub struct BrotliCompressor {
    level: CompressionLevel,
}

impl BrotliCompressor {
    /// Create a new Brotli compressor with default settings.
    pub fn new() -> Self {
        Self {
            level: CompressionLevel::Default,
        }
    }

    /// Create with compression level.
    pub fn with_level(level: CompressionLevel) -> Self {
        Self { level }
    }
}

impl Default for BrotliCompressor {
    fn default() -> Self {
        Self::new()
    }
}

impl Compressor for BrotliCompressor {
    fn algorithm(&self) -> Algorithm {
        Algorithm::Brotli
    }

    fn level(&self) -> CompressionLevel {
        self.level
    }

    fn compress(&self, input: &[u8]) -> Result<Vec<u8>> {
        let quality = map_quality(self.level);
        let mut output = Vec::new();

        {
            let mut writer =
                brotli::CompressorWriter::new(&mut output, BUFFER_SIZE, quality, DEFAULT_LG_WIN);
            writer
                .write_all(input)
                .map_err(|e| Error::algorithm("brotli", e.to_string()))?;
        }

        Ok(output)
    }

    fn compress_to(&self, input: &[u8], output: &mut [u8]) -> Result<usize> {
        let compressed = self.compress(input)?;
        if compressed.len() > output.len() {
            return Err(Error::buffer_too_small(compressed.len(), output.len()));
        }
        output[..compressed.len()].copy_from_slice(&compressed);
        Ok(compressed.len())
    }

    fn max_compressed_size(&self, input_len: usize) -> usize {
        // Brotli worst case: slightly larger than input
        input_len + (input_len >> 2) + 128
    }

    fn stats(&self) -> Option<CompressionStats> {
        None
    }
}

/// Brotli decompressor.
#[derive(Debug, Clone, Default)]
pub struct BrotliDecompressor;

impl BrotliDecompressor {
    /// Create a new Brotli decompressor.
    pub fn new() -> Self {
        Self
    }
}

impl Decompressor for BrotliDecompressor {
    fn algorithm(&self) -> Algorithm {
        Algorithm::Brotli
    }

    fn decompress(&self, input: &[u8]) -> Result<Vec<u8>> {
        let mut output = Vec::new();

        {
            let mut reader = brotli::Decompressor::new(input, BUFFER_SIZE);
            reader
                .read_to_end(&mut output)
                .map_err(|e| Error::algorithm("brotli", e.to_string()))?;
        }

        Ok(output)
    }

    fn decompress_to(&self, input: &[u8], output: &mut [u8]) -> Result<usize> {
        let decompressed = self.decompress(input)?;
        if decompressed.len() > output.len() {
            return Err(Error::buffer_too_small(decompressed.len(), output.len()));
        }
        output[..decompressed.len()].copy_from_slice(&decompressed);
        Ok(decompressed.len())
    }

    fn stats(&self) -> Option<CompressionStats> {
        None
    }
}

/// Brotli codec combining compression and decompression.
#[derive(Debug, Clone)]
pub struct BrotliCodec {
    level: CompressionLevel,
}

impl BrotliCodec {
    /// Create a new Brotli codec with default settings.
    pub fn new() -> Self {
        Self {
            level: CompressionLevel::Default,
        }
    }

    /// Create with compression level.
    pub fn with_level(level: CompressionLevel) -> Self {
        Self { level }
    }
}

impl Default for BrotliCodec {
    fn default() -> Self {
        Self::new()
    }
}

impl Compressor for BrotliCodec {
    fn algorithm(&self) -> Algorithm {
        Algorithm::Brotli
    }

    fn level(&self) -> CompressionLevel {
        self.level
    }

    fn compress(&self, input: &[u8]) -> Result<Vec<u8>> {
        let quality = map_quality(self.level);
        let mut output = Vec::new();

        {
            let mut writer =
                brotli::CompressorWriter::new(&mut output, BUFFER_SIZE, quality, DEFAULT_LG_WIN);
            writer
                .write_all(input)
                .map_err(|e| Error::algorithm("brotli", e.to_string()))?;
        }

        Ok(output)
    }

    fn compress_to(&self, input: &[u8], output: &mut [u8]) -> Result<usize> {
        let compressed = self.compress(input)?;
        if compressed.len() > output.len() {
            return Err(Error::buffer_too_small(compressed.len(), output.len()));
        }
        output[..compressed.len()].copy_from_slice(&compressed);
        Ok(compressed.len())
    }

    fn max_compressed_size(&self, input_len: usize) -> usize {
        input_len + (input_len >> 2) + 128
    }

    fn stats(&self) -> Option<CompressionStats> {
        None
    }
}

impl Decompressor for BrotliCodec {
    fn algorithm(&self) -> Algorithm {
        Algorithm::Brotli
    }

    fn decompress(&self, input: &[u8]) -> Result<Vec<u8>> {
        let mut output = Vec::new();

        {
            let mut reader = brotli::Decompressor::new(input, BUFFER_SIZE);
            reader
                .read_to_end(&mut output)
                .map_err(|e| Error::algorithm("brotli", e.to_string()))?;
        }

        Ok(output)
    }

    fn decompress_to(&self, input: &[u8], output: &mut [u8]) -> Result<usize> {
        let decompressed = self.decompress(input)?;
        if decompressed.len() > output.len() {
            return Err(Error::buffer_too_small(decompressed.len(), output.len()));
        }
        output[..decompressed.len()].copy_from_slice(&decompressed);
        Ok(decompressed.len())
    }

    fn stats(&self) -> Option<CompressionStats> {
        None
    }
}

impl Codec for BrotliCodec {
    fn new() -> Self {
        BrotliCodec::new()
    }

    fn with_level(level: CompressionLevel) -> Self {
        BrotliCodec::with_level(level)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_roundtrip_empty() {
        let codec = BrotliCodec::new();
        let input = b"";

        let compressed = codec.compress(input).unwrap();
        let decompressed = codec.decompress(&compressed).unwrap();

        assert_eq!(decompressed.as_slice(), input);
    }

    #[test]
    fn test_roundtrip_small() {
        let codec = BrotliCodec::new();
        let input = b"Hello, Brotli!";

        let compressed = codec.compress(input).unwrap();
        let decompressed = codec.decompress(&compressed).unwrap();

        assert_eq!(decompressed.as_slice(), input);
    }

    #[test]
    fn test_roundtrip_large() {
        let codec = BrotliCodec::new();
        let pattern = b"The quick brown fox jumps over the lazy dog. ";
        let input: Vec<u8> = pattern.iter().cycle().take(100_000).copied().collect();

        let compressed = codec.compress(&input).unwrap();

        // Should compress well
        assert!(compressed.len() < input.len());

        let decompressed = codec.decompress(&compressed).unwrap();
        assert_eq!(decompressed, input);
    }

    #[test]
    fn test_compression_levels() {
        let input =
            b"Testing compression levels for Brotli algorithm with some repetitive content.";

        for level in [
            CompressionLevel::None,
            CompressionLevel::Fast,
            CompressionLevel::Default,
            CompressionLevel::Best,
        ] {
            let codec = BrotliCodec::with_level(level);
            let compressed = codec.compress(input).unwrap();
            let decompressed = codec.decompress(&compressed).unwrap();
            assert_eq!(decompressed.as_slice(), input);
        }
    }

    #[test]
    fn test_verify_roundtrip() {
        let codec = BrotliCodec::new();
        let input = b"Verify roundtrip functionality for Brotli.";

        assert!(codec.verify_roundtrip(input).unwrap());
    }

    #[test]
    fn test_repetitive_data() {
        let codec = BrotliCodec::new();
        let input: Vec<u8> = vec![b'A'; 10_000];

        let compressed = codec.compress(&input).unwrap();

        // Highly repetitive data should compress very well
        assert!(compressed.len() < input.len() / 10);

        let decompressed = codec.decompress(&compressed).unwrap();
        assert_eq!(decompressed, input);
    }

    #[test]
    fn test_web_content() {
        // Brotli excels at web content - test with HTML-like data
        let codec = BrotliCodec::with_level(CompressionLevel::Best);
        let input = br#"
            <!DOCTYPE html>
            <html lang="en">
            <head>
                <meta charset="UTF-8">
                <title>Test Page</title>
                <style>
                    body { font-family: Arial, sans-serif; }
                    .container { max-width: 1200px; margin: 0 auto; }
                </style>
            </head>
            <body>
                <div class="container">
                    <h1>Hello, World!</h1>
                    <p>This is a test of Brotli compression on web content.</p>
                </div>
            </body>
            </html>
        "#;

        let compressed = codec.compress(input).unwrap();

        // Web content should compress very well
        assert!(compressed.len() < input.len() / 2);

        let decompressed = codec.decompress(&compressed).unwrap();
        assert_eq!(decompressed.as_slice(), input);
    }

    #[test]
    fn test_compressor_decompressor_separate() {
        let compressor = BrotliCompressor::with_level(CompressionLevel::Fast);
        let decompressor = BrotliDecompressor::new();

        let input = b"Testing separate compressor and decompressor.";

        let compressed = compressor.compress(input).unwrap();
        let decompressed = decompressor.decompress(&compressed).unwrap();

        assert_eq!(decompressed.as_slice(), input);
    }
}