Struct WrittenRecord

pub struct WrittenRecord<'a> { /* private fields */ }

A written Record within Redpanda.

A WrittenRecord is handed to on_record_written event handlers as the record that Redpanda wrote. The record contains a key value pair with some headers, along with the record’s timestamp.

Implementations

impl<'a> WrittenRecord<'a>

pub fn from_record( record: impl Into<BorrowedRecord<'a>>, timestamp: SystemTime, ) -> WrittenRecord<'a>

Create a new record without any copies.

NOTE: This method is useful for tests to mock out custom events to your transform function.

pub fn new( key: Option<&'a [u8]>, value: Option<&'a [u8]>, timestamp: SystemTime, ) -> WrittenRecord<'a>

Create a new record without any copies.

NOTE: This method is useful for tests to mock out custom events to your transform function.

pub fn new_with_headers( key: Option<&'a [u8]>, value: Option<&'a [u8]>, timestamp: SystemTime, headers: Vec<BorrowedHeader<'a>>, ) -> WrittenRecord<'a>

Create a new record without any copies.

NOTE: This method is useful for tests to mock out custom events to your transform function.

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

Returns the record’s key or None if there is no key.

pub fn value(&self) -> Option<&'a [u8]>

Returns the record’s value or None if there is no value.

pub fn timestamp(&self) -> SystemTime

Returns the record’s timestamp.

NOTE: Record timestamps in Redpanda have millisecond resolution.

pub fn headers(&self) -> &[BorrowedHeader<'a>]

Return the headers for this record.

Trait Implementations

impl<'a> AsRef<BorrowedRecord<'a>> for WrittenRecord<'a>

fn as_ref(&self) -> &BorrowedRecord<'a>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Debug for WrittenRecord<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a WrittenRecord<'a>> for BorrowedRecord<'a>

fn from(r: &'a WrittenRecord<'_>) -> BorrowedRecord<'a>

Converts to this type from the input type.

impl<'a> From<WrittenRecord<'a>> for BorrowedRecord<'a>

fn from(r: WrittenRecord<'a>) -> BorrowedRecord<'a>

Converts to this type from the input type.

impl<'a> PartialEq for WrittenRecord<'a>

fn eq(&self, other: &WrittenRecord<'a>) -> 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<'a> Eq for WrittenRecord<'a>

impl<'a> StructuralPartialEq for WrittenRecord<'a>