Struct ConsumerRecord 

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

A key/value pair to be received from Kafka. This also consists of a topic name and a partition number from which the record is being received, an offset that points to the record in a Kafka partition, and a timestamp as marked by the corresponding ProducerRecord.

Translation notes

Java’s record is not thread-safe because headers() hands out a mutable collection; here it hands out a shared reference, so the borrow rules make concurrent reads safe.

Implementations

impl<K, V> ConsumerRecord<K, V>

pub const NO_TIMESTAMP: i64 = -1

Sentinel value indicating no timestamp is associated with a record.

pub const NULL_SIZE: i32 = -1

Sentinel value used for serialized_key_size / serialized_value_size when the key/value is None.

pub fn new( topic: impl Into<Arc<str>>, partition: i32, offset: i64, key: Option<K>, value: Option<V>, ) -> Self

Creates a record to be received from a specified topic and partition (provided for compatibility with Kafka 0.9 before the message format supported timestamps and before serialized metadata were exposed).

Arguments

• topic - The topic this record is received from
• partition - The partition of the topic this record is received from
• offset - The offset of this record in the corresponding Kafka partition
• key - The key of the record, if one exists (None is allowed)
• value - The record contents

Returns

The new ConsumerRecord.

pub fn with_options(options: ConsumerRecordOptions<K, V>) -> Self

Creates a record to be received from a specified topic and partition.

Arguments

• options - The topic, partition, offset, timestamp, timestamp type, serialized key and value sizes, key, value, headers, leader epoch and delivery count of the record

Returns

The new ConsumerRecord.

pub fn topic(&self) -> &str

Returns the topic this record is received from.

pub fn partition(&self) -> i32

Returns the partition from which this record is received.

pub fn offset(&self) -> i64

Returns the position of this record in the corresponding Kafka partition.

pub fn timestamp(&self) -> i64

Returns the timestamp of this record, in milliseconds elapsed since unix epoch.

pub fn timestamp_type(&self) -> TimestampType

Returns the timestamp type of this record.

pub fn serialized_key_size(&self) -> i32

Returns the size of the serialized, uncompressed key in bytes. If key is None, the returned size is -1.

pub fn serialized_value_size(&self) -> i32

Returns the size of the serialized, uncompressed value in bytes. If value is None, the returned size is -1.

pub fn key(&self) -> Option<&K>

Returns the key (or None if no key is specified).

pub fn value(&self) -> Option<&V>

Returns the value.

pub fn headers(&self) -> &RecordHeaders

Returns the headers.

pub fn leader_epoch(&self) -> Option<i32>

Get the leader epoch for the record if available.

Returns

the leader epoch or empty for legacy record formats

pub fn delivery_count(&self) -> Option<i16>

Get the delivery count for the record if available.

Deliveries are counted for records delivered by share groups.

Returns

the delivery count or empty when deliveries not counted

Trait Implementations

impl<K: Clone, V: Clone> Clone for ConsumerRecord<K, V>

fn clone(&self) -> ConsumerRecord<K, V>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K, V> Debug for ConsumerRecord<K, V>

where K: Debug, V: Debug,

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

Formats the value using the given formatter.

impl<K, V> Display for ConsumerRecord<K, V>

where K: Debug, V: Debug,

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

Formats the value using the given formatter.