Struct rdkafka::consumer::stream_consumer::StreamConsumerContext

pub struct StreamConsumerContext<C> where
    C: ConsumerContext,  { /* fields omitted */ }

A consumer context wrapper for a stream consumer.

This context will automatically wake up the message stream when new data is available.

This type is not intended to be used directly. The construction of a StreamConsumer automatically wraps the underlying context in this type.

Implementations

impl<C> StreamConsumerContext<C> where
    C: ConsumerContext, 

pub fn inner(&self) -> &C

Returns a reference to the inner ConsumerContext used to create this context.

Trait Implementations

impl<C> ClientContext for StreamConsumerContext<C> where
    C: ConsumerContext, 

fn log(&self, level: RDKafkaLogLevel, fac: &str, log_message: &str)

Receives log lines from librdkafka.

fn stats(&self, statistics: Statistics)

Receives the statistics of the librdkafka client. To enable, the statistics.interval.ms configuration parameter must be specified.

fn error(&self, error: KafkaError, reason: &str)

Receives global errors from the librdkafka client.

impl<C, R> Consumer<StreamConsumerContext<C>> for StreamConsumer<C, R> where
    C: ConsumerContext, 

fn client(&self) -> &Client<StreamConsumerContext<C>>

Returns the Client underlying this consumer.

fn group_metadata(&self) -> Option<ConsumerGroupMetadata>

Returns the current consumer group metadata associated with the consumer.

fn subscribe(&self, topics: &[&str]) -> KafkaResult<()>

Subscribes the consumer to a list of topics.

fn unsubscribe(&self)

Unsubscribes the current subscription list.

fn assign(&self, assignment: &TopicPartitionList) -> KafkaResult<()>

Manually assigns topics and partitions to the consumer. If used, automatic consumer rebalance won’t be activated.

fn seek<T: Into<Timeout>>(
    &self,
    topic: &str,
    partition: i32,
    offset: Offset,
    timeout: T
) -> KafkaResult<()>

Seeks to offset for the specified topic and partition. After a successful call to seek, the next poll of the consumer will return the message with offset.

fn commit(
    &self,
    topic_partition_list: &TopicPartitionList,
    mode: CommitMode
) -> KafkaResult<()>

Commits the offset of the specified message. The commit can be sync (blocking), or async. Notice that when a specific offset is committed, all the previous offsets are considered committed as well. Use this method only if you are processing messages in order.

fn commit_consumer_state(&self, mode: CommitMode) -> KafkaResult<()>

Commits the current consumer state. Notice that if the consumer fails after a message has been received, but before the message has been processed by the user code, this might lead to data loss. Check the “at-least-once delivery” section in the readme for more information.

fn commit_message(
    &self,
    message: &BorrowedMessage<'_>,
    mode: CommitMode
) -> KafkaResult<()>

Commit the provided message. Note that this will also automatically commit every message with lower offset within the same partition.

fn store_offset(&self, message: &BorrowedMessage<'_>) -> KafkaResult<()>

Stores offset for this message to be used on the next (auto)commit. When using this enable.auto.offset.store should be set to false in the config.

fn store_offsets(&self, tpl: &TopicPartitionList) -> KafkaResult<()>

Store offsets to be used on the next (auto)commit. When using this enable.auto.offset.store should be set to false in the config.

fn subscription(&self) -> KafkaResult<TopicPartitionList>

Returns the current topic subscription.

fn assignment(&self) -> KafkaResult<TopicPartitionList>

Returns the current partition assignment.

fn committed<T>(&self, timeout: T) -> KafkaResult<TopicPartitionList> where
    T: Into<Timeout>,
    Self: Sized, 

Retrieves the committed offsets for topics and partitions.

fn committed_offsets<T>(
    &self,
    tpl: TopicPartitionList,
    timeout: T
) -> KafkaResult<TopicPartitionList> where
    T: Into<Timeout>, 

Retrieves the committed offsets for specified topics and partitions.

fn offsets_for_timestamp<T>(
    &self,
    timestamp: i64,
    timeout: T
) -> KafkaResult<TopicPartitionList> where
    T: Into<Timeout>,
    Self: Sized, 

Looks up the offsets for this consumer’s partitions by timestamp.

fn offsets_for_times<T>(
    &self,
    timestamps: TopicPartitionList,
    timeout: T
) -> KafkaResult<TopicPartitionList> where
    T: Into<Timeout>,
    Self: Sized, 

Looks up the offsets for the specified partitions by timestamp.

fn position(&self) -> KafkaResult<TopicPartitionList>

Retrieve current positions (offsets) for topics and partitions.

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

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

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

Returns the low and high watermarks for a specific topic and partition.

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

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

fn pause(&self, partitions: &TopicPartitionList) -> KafkaResult<()>

Pauses consumption for the provided list of partitions.

fn resume(&self, partitions: &TopicPartitionList) -> KafkaResult<()>

Resumes consumption for the provided list of partitions.

fn context(&self) -> &Arc<C>

Returns a reference to the ConsumerContext used to create this consumer.

impl<C> ConsumerContext for StreamConsumerContext<C> where
    C: ConsumerContext, 

fn rebalance(
    &self,
    native_client: &NativeClient,
    err: RDKafkaRespErr,
    tpl: &mut TopicPartitionList
)

Implements the default rebalancing strategy and calls the pre_rebalance and post_rebalance methods. If this method is overridden, it will be responsibility of the user to call them if needed.

fn pre_rebalance<'a>(&self, rebalance: &Rebalance<'a>)

Pre-rebalance callback. This method will run before the rebalance and should terminate its execution quickly.

fn post_rebalance<'a>(&self, rebalance: &Rebalance<'a>)

Post-rebalance callback. This method will run after the rebalance and should terminate its execution quickly.

fn commit_callback(&self, result: KafkaResult<()>, offsets: &TopicPartitionList)

Post commit callback. This method will run after a group of offsets was committed to the offset store.

fn main_queue_min_poll_interval(&self) -> Timeout

Returns the minimum interval at which to poll the main queue, which services the logging, stats, and error callbacks.

fn message_queue_nonempty_callback(&self)

Message queue nonempty callback. This method will run when the consumer’s message queue switches from empty to nonempty.