[][src]Crate rdkafka_sys

rdkafka-sys

Low level bindings to librdkafka.

Bindings

To regenerate the bindings:

git submodule update --init
cargo install bindgen --vers 0.30.0
bindgen --builtins --no-doc-comments librdkafka/src/rdkafka.h -o src/bindings/{platform}.rs

Version

The rdkafka-sys version number is in the format X.Y.Z-P, where X.Y.Z corresponds to the librdkafka version, and P indicates the version of the rust bindings.

Build

By default a submodule with the librdkafka sources pinned to a specific commit will be used to compile and statically link the library.

The dynamic_linking feature can be used to link rdkafka to a locally installed version of librdkafka: if the feature is enabled, the build script will use pkg-config to check the version of the library installed in the system, and it will configure the compiler to use dynamic linking.

The build process is defined in build.rs.

Updating

To upgrade change the git submodule in librdkafka, check if new errors need to be added to helpers::primive_to_rd_kafka_resp_err_t and update the version in Cargo.toml.

Re-exports

pub use bindings::*;
pub use helpers::*;
pub use types::*;

Modules

bindings
helpers
types

This module contains type aliases for types defined in the auto-generated bindings.