precomp2 0.2.0

Reversible preprocessing for compressed and container data.
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

# precomp2

`precomp2` is a Rust library for reversible preprocessing of compressed and container data. It turns recognizable streams into PCF2 segments that are easier for an outer compressor to handle, then restores the original bytes exactly.

The project is inspired by [precomp-cpp](https://github.com/schnaader/precomp-cpp) and [preflate-rs](https://github.com/microsoft/preflate-rs).

## Features

- Lossless encode/decode APIs for byte slices and async decode input.
- PCF2 segment container with literal, nested, DEFLATE, zlib, gzip, PNG IDAT, JPEG, Base64, bzip2, and PDF stream segment kinds.
- Recursive preprocessing with depth and output budget limits.
- Configurable PNG and PDF preprocessing through `EncodeConfig`.

## Usage

```rust
use precomp2::{DecodeConfig, EncodeConfig};

fn main() -> precomp2::Result<()> {
    let input = b"payload";
    let encoded = precomp2::encode_bytes(input, &EncodeConfig::default())?;
    let decoded = precomp2::decode_bytes(&encoded, &DecodeConfig::default())?;

    assert_eq!(decoded, input);
    Ok(())
}
```

## Status

This crate is early-stage. The on-disk PCF2 format should be treated as unstable until a 1.0 release.

## License

Licensed under the Apache License, Version 2.0.