rust-rdkafka

crates.io docs.rs Build Status Join the chat at https://gitter.im/rust-rdkafka/Lobby

Kafka client library for Rust based on [librdkafka].

The library

rust-rdkafka provides a safe Rust interface to librdkafka. It currently exports a subset of the funcionalities provided by librdkafka 0.9.2.

rust-rdkafka provides low level and high level consumers and producers. Low level:

High level:

Warning: the library is under active development and the APIs are likely to change.

Installation

Add this to your Cargo.toml:

toml [dependencies] rdkafka = "^0.6.0"

This crate will compile librdkafka from sources and link it statically to your executable. To compile librdkafka you'll need:

To enable ssl and sasl, use the features field in Cargo.toml. Example:

toml [dependencies.rdkafka] version = "^0.6.0" features = ["ssl", "sasl"]

Compiling from sources

To compile from sources, you'll have to update the submodule containing librdkafka:

bash git submodule update --init

and then compile using cargo, selecting the features that you want. Example:

bash cargo build --features "ssl sasl"

Examples

You can find examples in the examples folder. To run them:

bash cargo run --example <example_name> -- <example_args>

Tests

The unit tests can run without a Kafka broker present:

bash cargo test --lib

To run the full suite:

bash cargo test

In this case there is a broker expected to be running on localhost:9092. Travis currently only runs the unit tests.

Documentation

Documentation is available on docs.rs.

Contributors

Thanks to: * Thijs Cadier - thijsc

Alternatives