Struct rdkafka::client::Client

pub struct Client<C: ClientContext = DefaultClientContext> { /* fields omitted */ }

A low-level rdkafka client.

This type is the basis of the consumers and producers in the consumer and producer modules, respectively.

Typically you do not want to construct a Client directly, but instead construct a consumer or producer. A Client can be used, however, when only access to cluster metadata and watermarks is required.

Implementations

impl<C: ClientContext> Client<C>

pub fn new(
    config: &ClientConfig,
    native_config: NativeClientConfig,
    rd_kafka_type: RDKafkaType,
    context: C
) -> KafkaResult<Client<C>>

Creates a new Client given a configuration, a client type and a context.

pub fn native_client(&self) -> &NativeClient

Returns a reference to the native rdkafka-sys client.

pub fn native_ptr(&self) -> *mut RDKafka

Returns a pointer to the native rdkafka-sys client.

pub fn context(&self) -> &C

Returns a reference to the context.

pub fn fetch_metadata<T: Into<Timeout>>(
    &self,
    topic: Option<&str>,
    timeout: T
) -> KafkaResult<Metadata>

Returns the metadata information for the specified topic, or for all topics in the cluster if no topic is specified.

pub fn fetch_watermarks<T: Into<Timeout>>(
    &self,
    topic: &str,
    partition: i32,
    timeout: T
) -> KafkaResult<(i64, i64)>

Returns high and low watermark for the specified topic and partition.

pub fn fetch_group_list<T: Into<Timeout>>(
    &self,
    group: Option<&str>,
    timeout: T
) -> KafkaResult<GroupList>

Returns the group membership information for the given group. If no group is specified, all groups will be returned.