Struct ProducerRecord 

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

A key/value pair to be sent to Kafka. This consists of a topic name to which the record is being sent, an optional partition number, and an optional key and value.

If a valid partition number is specified that partition will be used when sending the record. If no partition is specified but a key is present a partition will be chosen using a hash of the key. If neither key nor partition is present a partition will be assigned in a round-robin fashion. Note that partition numbers are 0-indexed.

The record also has an associated timestamp. If the user did not provide a timestamp, the producer will stamp the record with its current time. The timestamp eventually used by Kafka depends on the timestamp type configured for the topic.

• If the topic is configured to use CreateTime, the timestamp in the producer record will be used by the broker.
• If the topic is configured to use LogAppendTime, the timestamp in the producer record will be overwritten by the broker with the broker local time when it appends the message to its log.

In either case, the timestamp that has actually been used will be returned to the user in RecordMetadata.

Implementations

impl<K, V> ProducerRecord<K, V>

pub fn with_options( options: ProducerRecordOptions<K, V>, ) -> Result<Self, LocalIllegalArgumentError>

Creates a record with a specified timestamp to be sent to a specified topic and partition

Arguments

• options - The topic the record will be appended to, the partition to which the record should be sent, the timestamp of the record in milliseconds since epoch (if None, the producer will assign the timestamp using the system clock), the key and the headers that will be included in the record, and the record contents

Errors

• LocalIllegalArgumentError if the timestamp or the partition is negative.

Translation notes

Java’s ProducerRecord(String, Integer, Long, K, V, Iterable<Header>): its six parameters are the fields of ProducerRecordOptions.

pub fn with_partition_timestamp_key( topic: String, partition: Option<i32>, timestamp: Option<i64>, key: Option<K>, value: Option<V>, ) -> Result<Self, LocalIllegalArgumentError>

Creates a record with a specified timestamp to be sent to a specified topic and partition

Arguments

• topic - The topic the record will be appended to
• partition - The partition to which the record should be sent
• timestamp - The timestamp of the record, in milliseconds since epoch. If None, the producer will assign the timestamp using System.currentTimeMillis().
• key - The key that will be included in the record
• value - The record contents

Errors

• LocalIllegalArgumentError if the timestamp or the partition is negative.

pub fn with_partition_key_headers( topic: String, partition: Option<i32>, key: Option<K>, value: Option<V>, headers: RecordHeaders, ) -> Result<Self, LocalIllegalArgumentError>

Creates a record to be sent to a specified topic and partition

Arguments

• topic - The topic the record will be appended to
• partition - The partition to which the record should be sent
• key - The key that will be included in the record
• value - The record contents
• headers - The headers that will be included in the record

Errors

• LocalIllegalArgumentError if the partition is negative.

pub fn with_partition_key( topic: String, partition: Option<i32>, key: Option<K>, value: Option<V>, ) -> Result<Self, LocalIllegalArgumentError>

Creates a record to be sent to a specified topic and partition

Arguments

• topic - The topic the record will be appended to
• partition - The partition to which the record should be sent
• key - The key that will be included in the record
• value - The record contents

Errors

• LocalIllegalArgumentError if the partition is negative.

pub fn with_key(topic: String, key: Option<K>, value: Option<V>) -> Self

Create a record to be sent to Kafka

Arguments

• topic - The topic the record will be appended to
• key - The key that will be included in the record
• value - The record contents

pub fn new(topic: String, value: Option<V>) -> Self

Create a record with no key

Arguments

• topic - The topic this record should be sent to
• value - The record contents

pub fn topic(&self) -> &str

Returns the topic this record is being sent to.

pub fn headers(&self) -> &RecordHeaders

Returns the headers.

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 timestamp(&self) -> Option<i64>

Returns the timestamp, which is in milliseconds since epoch.

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

Returns the partition to which the record will be sent (or None if no partition was specified).

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<K: Debug, V: Debug> Display for ProducerRecord<K, V>

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

Formats the value using the given formatter.

impl<K: Hash, V: Hash> Hash for ProducerRecord<K, V>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

fn eq(&self, other: &Self) -> 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 ProducerRecord<K, V>