Struct BaseRecord

pub struct BaseRecord<'a, K: ToBytes + ?Sized = (), P: ToBytes + ?Sized = (), D: IntoOpaque = ()> {
    pub topic: &'a str,
    pub partition: Option<i32>,
    pub payload: Option<&'a P>,
    pub key: Option<&'a K>,
    pub timestamp: Option<i64>,
    pub headers: Option<OwnedHeaders>,
    pub delivery_opaque: D,
}

A record for the BaseProducer and ThreadedProducer.

The BaseRecord is a structure that can be used to provide a new record to BaseProducer::send or ThreadedProducer::send. Since most fields are optional, a BaseRecord can be constructed using the builder pattern.

Examples

This example will create a BaseRecord with no DeliveryOpaque:

let record = BaseRecord::to("topic_name")  // destination topic
    .key(&[1, 2, 3, 4])                    // message key
    .payload("content")                    // message payload
    .partition(5);                         // target partition

The following example will build a similar record, but it will use a number as the DeliveryOpaque for the message:

let record = BaseRecord::with_opaque_to("topic_name", 123) // destination topic and message id
    .key(&[1, 2, 3, 4])                                    // message key
    .payload("content")                                    // message payload
    .partition(5);                                         // target partition

Fields

topic: &'a str

Required destination topic.

partition: Option<i32>

Optional destination partition.

payload: Option<&'a P>

Optional payload.

key: Option<&'a K>

Optional key.

timestamp: Option<i64>

Optional timestamp.

Note that Kafka represents timestamps as the number of milliseconds since the Unix epoch.

headers: Option<OwnedHeaders>

Optional message headers.

delivery_opaque: D

Required delivery opaque (defaults to () if not required).

Implementations

impl<'a, K: ToBytes + ?Sized, P: ToBytes + ?Sized, D: IntoOpaque> BaseRecord<'a, K, P, D>

pub fn with_opaque_to( topic: &'a str, delivery_opaque: D, ) -> BaseRecord<'a, K, P, D>

Creates a new record with the specified topic name and delivery opaque.

pub fn partition(self, partition: i32) -> BaseRecord<'a, K, P, D>

Sets the destination partition of the record.

pub fn payload(self, payload: &'a P) -> BaseRecord<'a, K, P, D>

Sets the payload of the record.

pub fn key(self, key: &'a K) -> BaseRecord<'a, K, P, D>

Sets the key of the record.

pub fn timestamp(self, timestamp: i64) -> BaseRecord<'a, K, P, D>

Sets the timestamp of the record.

Note that Kafka represents timestamps as the number of milliseconds since the Unix epoch.

pub fn headers(self, headers: OwnedHeaders) -> BaseRecord<'a, K, P, D>

Sets the headers of the record.

impl<'a, K: ToBytes + ?Sized, P: ToBytes + ?Sized> BaseRecord<'a, K, P, ()>

pub fn to(topic: &'a str) -> BaseRecord<'a, K, P, ()>

Creates a new record with the specified topic name.

Trait Implementations

impl<'a, K: Debug + ToBytes + ?Sized, P: Debug + ToBytes + ?Sized, D: Debug + IntoOpaque> Debug for BaseRecord<'a, K, P, D>

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

Formats the value using the given formatter.