Struct ConsumerRecords 

pub struct ConsumerRecords<K, V> { /* private fields */ }

A container that holds the list ConsumerRecord per partition for a particular topic. There is one ConsumerRecord list for every topic partition returned by a Consumer::poll operation.

Implementations

impl<K, V> ConsumerRecords<K, V>

pub fn with_next_offsets( records: IndexMap<TopicPartition, Vec<ConsumerRecord<K, V>>>, next_offsets: HashMap<TopicPartition, OffsetAndMetadata>, ) -> Self

Constructs a new ConsumerRecords with the given records and next offsets.

Arguments

• records - The records for each partition
• next_offsets - The next offset and metadata for each partition whose position was advanced during the poll call. These represent the offsets that the consumer will start reading from on the next poll.

Returns

The new ConsumerRecords.

pub fn empty() -> Self

Returns an empty ConsumerRecords instance.

Returns

An empty ConsumerRecords.

pub fn records_with_partition( &self, partition: &TopicPartition, ) -> &[ConsumerRecord<K, V>]

Get just the records for the given partition.

Arguments

• partition - The partition to get records for

Returns

The records, an empty slice if there are none.

pub fn records_with_topic<'a>( &'a self, topic: &'a str, ) -> impl Iterator<Item = &'a ConsumerRecord<K, V>> + 'a

Get just the records for the given topic.

Arguments

• topic - The topic to get records for

Returns

An iterator over the records, in partition-insertion order.

pub fn partitions(&self) -> impl Iterator<Item = &TopicPartition>

Get the partitions which have records contained in this record set.

Returns

The set of partitions with data in this record set (may be empty if no data was returned), as an iterator in insertion order.

pub fn count(&self) -> usize

Returns the number of records for all topics.

pub fn is_empty(&self) -> bool

Returns whether this container has any records.

Returns

True if there are no records, false otherwise

pub fn next_offsets(&self) -> &HashMap<TopicPartition, OffsetAndMetadata>

Get the next offsets and metadata corresponding to all topic partitions for which the position have been advanced in this poll call.

Returns

The next offsets that the consumer will consume

Trait Implementations

impl<K: Debug, V: Debug> Debug for ConsumerRecords<K, V>

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

Formats the value using the given formatter.

impl<K, V> Default for ConsumerRecords<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, K, V> IntoIterator for &'a ConsumerRecords<K, V>

Borrowed iteration over every record across all partitions (in partition-insertion order).

Equivalent to Java’s ConsumerRecords.iterator() (which iterates the concatenated values of the underlying map).

type Item = &'a ConsumerRecord<K, V>

The type of the elements being iterated over.

type IntoIter = FlatMap<Values<'a, TopicPartition, Vec<ConsumerRecord<K, V>>>, Iter<'a, ConsumerRecord<K, V>>, fn(&'a Vec<ConsumerRecord<K, V>>) -> Iter<'a, ConsumerRecord<K, V>>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V> IntoIterator for ConsumerRecords<K, V>

Owned iteration that consumes the ConsumerRecords.

type Item = ConsumerRecord<K, V>

The type of the elements being iterated over.

type IntoIter = FlatMap<IntoValues<TopicPartition, Vec<ConsumerRecord<K, V>>>, IntoIter<ConsumerRecord<K, V>>, fn(Vec<ConsumerRecord<K, V>>) -> IntoIter<ConsumerRecord<K, V>>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.