crabka-compression 0.3.2

Kafka wire-protocol compression codecs for Rust
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

# crabka-compression

[![Crates.io](https://img.shields.io/crates/v/crabka-compression.svg)](https://crates.io/crates/crabka-compression)
[![Docs.rs](https://docs.rs/crabka-compression/badge.svg)](https://docs.rs/crabka-compression)
[![CI](https://github.com/robot-head/crabka/actions/workflows/ci.yml/badge.svg)](https://github.com/robot-head/crabka/actions/workflows/ci.yml)

Kafka wire-protocol compression codecs for Rust. Implements the four
codecs Apache Kafka uses on the wire — gzip, snappy, lz4, zstd — with
byte-level wire compatibility verified against the JVM `kafka-clients`
implementation.

## Usage example

```rust
use crabka_compression::{compress, decompress, CompressionType};

let bytes = compress(CompressionType::Snappy, b"hello kafka").unwrap();
let back  = decompress(CompressionType::Snappy, &bytes).unwrap();
assert_eq!(back.as_ref(), b"hello kafka");
```

## Features

Default features enable all four codecs. Disable individually:

```toml
crabka-compression = { version = "0.3.2", default-features = false, features = ["gzip", "zstd"] }
```

Calling a codec whose feature is off returns
`CompressionError::FeatureDisabled`.

## Kafka-specific framing

- **Snappy** uses xerial-snappy framing (Kafka does not use Google's
  official Snappy stream format).
- **LZ4** uses the LZ4 frame format with independent blocks, 64 KiB
  block size, no checksums.
- **Gzip** is plain RFC-1952.
- **Zstd** is plain zstd frame at level 3.

## MSRV

Rust 1.95.0.

## License

Apache-2.0. Derivative work of [Apache Kafka](https://kafka.apache.org); see `NOTICE`.