Crate rdkafka [−] [src]

rust-rdkafka

Kafka client library for Rust based on librdkafka.

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:

BaseConsumer: simple wrapper around the librdkafka consumer. It requires to be periodically poll()ed in order to execute callbacks, rebalance and receive messages.
BaseProducer: simple wrapper around the librdkafka producer. As in the consumer case, the user must call poll() periodically to execute delivery callbacks.

High level:

StreamConsumer: it returns a stream of messages and takes care of polling the consumer internally.
FutureProducer: it returns a future that will be completed once the message is delivered to Kafka (or failed).

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

Add this to your Cargo.toml:

[dependencies]
rdkafka = "^0.4.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:

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

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

git submodule update --init

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

cargo build --features "ssl sasl"

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

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

The unit tests can run without a Kafka broker present:

cargo test --lib

To run the full suite:

cargo test

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

client	Common client funcionalities.
config	Configuration to create a Consumer or Producer.
consumer	Base trait and common functionalities for all consumers.
error	Error manipulations.
message	Store and manipulate Kafka messages.
producer	Producer implementations.
topic_partition_list	A data structure representing topic, partitions and offsets, compatible with the `RDKafkaTopicPartitionList` exported by `rdkafka-sys`.
util	Utility functions.