Skip to main content

Consumer

Struct Consumer 

Source
pub struct Consumer { /* private fields */ }
Expand description

High-level consumer that manages offset tracking and auto-commit.

Wraps one or more partitions across subscribed topics, polling them round-robin and tracking the latest consumed offset per partition.

Implementations§

Source§

impl Consumer

Source

pub async fn new(config: ConsumerConfig) -> Result<Self>

Create and connect a new consumer.

Connects to the first available bootstrap server, authenticates if configured, and discovers partition assignments for subscribed topics.

§Auto-commit semantics

When auto_commit_interval is set, offsets are committed periodically at the next-fetch position. This provides at-most-once semantics: if the application crashes between poll() returning and the records being processed, those records will be skipped on restart.

For at-least-once semantics, disable auto-commit and call commit() explicitly after processing each batch.

Source

pub fn set_rebalance_listener(&mut self, listener: Arc<dyn RebalanceListener>)

Register a rebalance listener for partition revocation/assignment events.

The listener is invoked during discover_assignments():

  • on_partitions_revoked is called with the old assignment before reassignment
  • on_partitions_assigned is called with the new assignment after reassignment
Source

pub async fn poll(&mut self) -> Result<Vec<ConsumerRecord>>

Poll for new records across all assigned partitions.

Automatically reconnects with exponential backoff on connection errors and periodically re-discovers partition assignments.

Source

pub async fn commit(&mut self) -> Result<()>

Commit current offsets to the server.

Automatically reconnects on connection errors.

Source

pub fn seek(&mut self, topic: impl Into<String>, partition: u32, offset: u64)

Seek a specific partition to a given offset.

The next poll() will fetch from this offset for the specified partition.

Source

pub fn seek_to_beginning(&mut self, topic: &str)

Seek all partitions of a topic to the beginning (offset 0).

Source

pub fn position(&self, topic: &str, partition: u32) -> Option<u64>

Get the current offset position for a (topic, partition) pair.

Source

pub fn assignments(&self) -> &HashMap<String, Vec<u32>>

Get current partition assignments.

Source

pub fn group_id(&self) -> &str

Get the consumer group ID.

Source

pub async fn close(self) -> Result<()>

Close the consumer, committing final offsets and leaving the group.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more