compcol 0.1.0

A no_std collection of compression algorithms behind a uniform streaming trait, gated per-algorithm by Cargo features.
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

//! RFC 1951 deflate.
//!
//! Streaming encoder + decoder behind a shared [`crate::Algorithm`]
//! implementation. The encoder uses LZ77 (hash-chain match finder, lazy
//! matching) followed by length-limited dynamic Huffman coding via the
//! Larmore–Hirschberg package-merge algorithm. The decoder handles all
//! three block types (stored, fixed-Huffman, dynamic-Huffman) defined by
//! RFC 1951.
//!
//! Both directions are fully streaming: the caller owns the input/output
//! buffers and the codec preserves its state across `encode`/`decode` calls.
//! The decoder keeps the 32 KiB sliding window on the heap.

mod tables;

pub mod decoder;
pub mod encoder;
pub mod lz77;

pub use decoder::Decoder;
pub use encoder::Encoder;

use crate::traits::Algorithm;

/// Zero-sized marker type implementing [`Algorithm`] for raw deflate.
#[derive(Debug, Clone, Copy, Default)]
pub struct Deflate;

impl Algorithm for Deflate {
    const NAME: &'static str = "deflate";
    type Encoder = Encoder;
    type Decoder = Decoder;

    fn encoder() -> Encoder {
        Encoder::new()
    }
    fn decoder() -> Decoder {
        Decoder::new()
    }
}