Struct ConsumerRecords 

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

A container that holds the list of ConsumerRecord per partition for a particular topic.

There is one ConsumerRecord list for every topic-partition returned by a Consumer::poll(...) operation.

Corresponds to Java’s org.apache.kafka.clients.consumer.ConsumerRecords<K, V>.

Uses an [IndexMap] internally so iteration order matches insertion order (Java’s ConsumerRecords is documented as iterating per the underlying map’s iteration order; the test suite assumes ordering matches insertion when a LinkedHashMap is supplied).

Equality

PartialEq / Eq are derived (gated on K: PartialEq, V: PartialEq / K: Eq, V: Eq) so that tests can assert_eq!(actual, expected) against an entire batch. Mirrors Java’s ConsumerRecordsTest which uses assertEquals on whole-batch values. The bounds are gated; users with non-PartialEq keys/values are unaffected.

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

Create a new ConsumerRecords from per-partition record lists and a next-offsets map.

Corresponds to Java’s ConsumerRecords(Map, Map) (ConsumerRecords.java:62). Java’s deprecated ConsumerRecords(Map), which supplies no next offsets, is not translated (CLAUDE.md §3).

pub fn empty() -> Self

Returns an empty ConsumerRecords.

Corresponds to Java’s static ConsumerRecords.empty() / ConsumerRecords.EMPTY.

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

Get the records for the given partition.

Returns an empty slice if no records are present for that partition.

Corresponds to Java’s ConsumerRecords.records(TopicPartition).

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

Get the records for the given topic, across all partitions in this record set.

Returns an iterator that yields references to records in partition-insertion order.

Corresponds to Java’s ConsumerRecords.records(String).

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

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

Returns an iterator over partition references in insertion order. The set may be empty if no data was returned.

Corresponds to Java’s ConsumerRecords.partitions().

pub fn count(&self) -> usize

The number of records across all topics and partitions in this set.

pub fn is_empty(&self) -> bool

true if this record set has no partitions.

Matches Java’s ConsumerRecords.isEmpty() exactly (Java returns records.isEmpty(), not count() == 0).

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

Get the next offsets and metadata for all topic-partitions for which the position has been advanced in this poll call.

Corresponds to Java’s ConsumerRecords.nextOffsets().

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.

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

fn eq(&self, other: &ConsumerRecords<K, V>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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