rustfs-kafka 1.2.0

Rust client for Apache Kafka
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

# rustfs-kafka

[![Rust](https://github.com/houseme/kafka-rust/actions/workflows/rust.yml/badge.svg)](https://github.com/houseme/kafka-rust/actions/workflows/rust.yml)
[![crates.io](https://img.shields.io/crates/v/rustfs-kafka.svg)](https://crates.io/crates/rustfs-kafka)
[![docs.rs](https://docs.rs/rustfs-kafka/badge.svg)](https://docs.rs/rustfs-kafka/)
[![License](https://img.shields.io/crates/l/rustfs-kafka)](LICENSE)
[![Crates.io](https://img.shields.io/crates/d/rustfs-kafka)](https://crates.io/crates/rustfs-kafka)

Fork project: forked from [kafka-rust](https://github.com/kafka-rust/kafka-rust).

`rustfs-kafka` is a Rust Kafka client workspace containing:

- `rustfs-kafka`: synchronous client/producer/consumer/admin APIs.
- `rustfs-kafka-async`: async wrapper crate based on tokio.

Current release target: `1.2.0`.

## Crates

```toml
[dependencies]
rustfs-kafka = "1.2.0"
rustfs-kafka-async = "1.2.0"
```

## Core Features

- Kafka client metadata, fetch, produce, and offset commit APIs.
- High-level `Consumer` and `Producer` abstractions.
- TLS support via rustls:
    - `security` (default, aws-lc-rs provider)
    - `security-ring` (ring provider)
- Async security authentication support includes SASL `PLAIN`, `SCRAM-SHA-256`, and `SCRAM-SHA-512` over TLS.
- Optional `metrics` support.
- Optional `producer_timestamp`.
- Integration test harness with Kafka `3.9.2`, `4.1.2`, and `4.2.0`.

## Feature Flags (`rustfs-kafka`)

| Feature              | Default | Description                          |
|----------------------|---------|--------------------------------------|
| `security`           | Yes     | rustls + aws-lc-rs TLS backend       |
| `security-ring`      | No      | rustls + ring TLS backend            |
| `metrics`            | No      | metrics integration                  |
| `producer_timestamp` | No      | producer timestamp support           |
| `nightly`            | No      | nightly-only optimizations           |
| `integration_tests`  | No      | integration test compilation helpers |

Note: compression codec support is provided by `kafka-protocol`; enable the needed codec features on that dependency
when required.

## Documentation

- API docs: [docs.rs/rustfs-kafka](https://docs.rs/rustfs-kafka/)
- Workspace docs index: [docs/README.md](docs/README.md)
- Usage guide (sync + async): [docs/usage-guide.md](docs/usage-guide.md)
- Async crate readme: [crates/rustfs-kafka-async/README.md](crates/rustfs-kafka-async/README.md)

## Local Development

```bash
cargo build
cargo test
cargo clippy --all-targets --all-features -- -D warnings
```

Integration tests (Docker required):

```bash
cd crates/rustfs-kafka/tests
./run-all-tests
./run-sync-secure-tests
./run-async-secure-tests
```

## License

Apache License 2.0. See [LICENSE](LICENSE).