Skip to main content

Consumer

Struct Consumer 

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

Direct Kafka consumer for manually assigned topic partitions.

Implementations§

Source§

impl Consumer

Source

pub fn assign(&mut self, topic: impl Into<String>, partition: i32, offset: i64)

Assigns a topic partition and next offset to fetch.

Source

pub fn assignments(&self) -> &[ConsumerAssignment]

Returns the current topic partition assignments.

Source

pub fn split_partition_queue( &mut self, topic: impl Into<String>, partition: i32, ) -> Result<ConsumerPartitionQueue>

Splits one assigned topic partition into a bounded receive queue.

Records fetched for the partition are delivered to the returned queue instead of the vector returned by Self::poll. The queue capacity is configured with ConsumerConfig::partition_queue_capacity. When the queue is full, poll returns an error and does not advance beyond the last record accepted by the queue.

Source

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

Returns the next offset for an assigned topic partition.

Source

pub fn seek(&mut self, topic: &str, partition: i32, offset: i64) -> Result<()>

Changes the next offset for an assigned topic partition.

Source

pub fn pause(&mut self, topic: &str, partition: i32) -> Result<()>

Pauses fetching from an assigned topic partition.

Source

pub fn resume(&mut self, topic: &str, partition: i32) -> Result<()>

Resumes fetching from an assigned topic partition.

Source

pub async fn fetch_watermarks( &mut self, topic: impl Into<String>, partition: i32, ) -> Result<PartitionWatermarks>

Fetches the earliest and latest available offsets for a topic partition.

The partition does not need to be assigned to this consumer. Kafka’s latest offset is the next offset after the current log end.

Source

pub async fn offset_for_leader_epoch( &mut self, topic: impl Into<String>, partition: i32, current_leader_epoch: i32, leader_epoch: i32, ) -> Result<LeaderEpochOffset>

Resolves the end offset for a partition leader epoch.

current_leader_epoch is the epoch from the consumer’s current metadata, or -1 when it is unknown. leader_epoch is the epoch whose end offset should be returned. The partition does not need to be assigned to this consumer.

Source

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

Polls assigned partitions and advances in-memory offsets for fetched records.

Source

pub async fn fetch( &mut self, topic: impl Into<String>, partition: i32, offset: i64, ) -> Result<Vec<ConsumerRecord>>

Fetches records for one topic partition without changing assignment state.

Trait Implementations§

Source§

impl Debug for Consumer

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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