Struct OwnedMessage

pub struct OwnedMessage { /* private fields */ }

A Kafka message that owns its backing data.

An OwnedMessage can be created from a BorrowedMessage using the BorrowedMessage::detach method. OwnedMessages don’t hold any reference to the consumer and don’t use any memory inside the consumer buffer.

Implementations

impl OwnedMessage

pub fn new( payload: Option<Vec<u8>>, key: Option<Vec<u8>>, topic: String, timestamp: Timestamp, partition: i32, offset: i64, headers: Option<OwnedHeaders>, ) -> OwnedMessage

Creates a new message with the specified content.

This function is mainly useful in tests of rust-rdkafka itself.

pub fn detach_headers(&mut self) -> Option<OwnedHeaders>

Detaches the OwnedHeaders from this OwnedMessage.

pub fn replace_headers(self, headers: Option<OwnedHeaders>) -> Self

Replaces the OwnedHeaders on this OwnedMessage.

pub fn set_payload(self, payload: Option<Vec<u8>>) -> Self

Sets the payload for this OwnedMessage.

pub fn set_key(self, key: Option<Vec<u8>>) -> Self

Sets the key for this OwnedMessage.

pub fn set_topic(self, topic: String) -> Self

Sets the topic for this OwnedMessage.

pub fn set_timestamp(self, timestamp: Timestamp) -> Self

Sets the timestamp for this OwnedMessage.

pub fn set_partition(self, partition: i32) -> Self

Sets the partition for this OwnedMessage.

pub fn set_offset(self, offset: i64) -> Self

Sets the offset for this OwnedMessage.

Trait Implementations

impl Clone for OwnedMessage

fn clone(&self) -> OwnedMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedMessage

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

Formats the value using the given formatter.

impl Message for OwnedMessage

type Headers = OwnedHeaders

The type of headers that this message contains.

fn key(&self) -> Option<&[u8]>

Returns the key of the message, or None if there is no key.

fn payload(&self) -> Option<&[u8]>

Returns the payload of the message, or None if there is no payload.

unsafe fn payload_mut(&mut self) -> Option<&mut [u8]>

Returns a mutable reference to the payload of the message, or None if there is no payload.

fn topic(&self) -> &str

Returns the source topic of the message.

fn partition(&self) -> i32

Returns the partition number where the message is stored.

fn offset(&self) -> i64

Returns the offset of the message within the partition.

fn timestamp(&self) -> Timestamp

Returns the message timestamp.

fn headers(&self) -> Option<&OwnedHeaders>

Returns the headers of the message, or None if there are no headers.

fn payload_view<P: ?Sized + FromBytes>(&self) -> Option<Result<&P, P::Error>>

Converts the raw bytes of the payload to a reference of the specified type, that points to the same data inside the message and without performing any memory allocation.

fn key_view<K: ?Sized + FromBytes>(&self) -> Option<Result<&K, K::Error>>

Converts the raw bytes of the key to a reference of the specified type, that points to the same data inside the message and without performing any memory allocation.