Struct RecordBatch 

pub struct RecordBatch {
    pub base_offset: i64,
    pub partition_leader_epoch: i32,
    pub attributes: Attributes,
    pub last_offset_delta: i32,
    pub base_timestamp: i64,
    pub max_timestamp: i64,
    pub producer_id: i64,
    pub producer_epoch: i16,
    pub base_sequence: i32,
    pub records: Vec<Record>,
}

Fields

base_offset: i64

partition_leader_epoch: i32

attributes: Attributes

last_offset_delta: i32

base_timestamp: i64

max_timestamp: i64

producer_id: i64

producer_epoch: i16

base_sequence: i32

records: Vec<Record>

Implementations

impl RecordBatch

pub fn delete_horizon_ms(&self) -> Option<i64>

KIP-534 delete horizon, if the delete-horizon attribute bit is set.

base_timestamp carries the horizon. There is no separate wire field.

pub fn with_delete_horizon(self, horizon_ms: i64) -> Self

Stamp the delete horizon onto this batch.

This method sets bit 6 and moves the horizon into base_timestamp. It then rewrites every record’s timestamp_delta, so the reconstructed absolute timestamps base_timestamp + delta do not change.

pub fn decode<B: Buf>(buf: &mut B) -> Result<Self, RecordsError>

Decode a complete v2 record batch from buf.

This method reads from the start of the header.

Errors

Returns the underlying protocol error when input is truncated, contains an invalid length or tag, or cannot be encoded for the selected version.

Panics

Panics if a value previously validated by the protocol type no longer satisfies its encoded-length or field-range invariant.

pub fn decode_with_policy<B: Buf>( buf: &mut B, policy: RecordDecompressionPolicy, ) -> Result<Self, RecordsError>

Decode a complete v2 record batch with explicit decompression limits.

Errors

Returns the underlying records error for malformed, truncated, corrupt, or over-limit input.

Panics

Panics if a value previously validated by the protocol type no longer satisfies its field-range invariant.

pub fn encode<B: BufMut>(&self, buf: &mut B) -> Result<(), RecordsError>

Encode this batch into buf.

Errors

Returns the underlying protocol error when input is truncated, contains an invalid length or tag, or cannot be encoded for the selected version.

pub fn encode_to_bytes(&self) -> Result<Bytes, RecordsError>

Encode this batch into an owned wire buffer.

Uncompressed records are written directly behind the header, avoiding a temporary body buffer and its copy into the output.

Errors

Returns the same encoding errors as Self::encode.

pub fn encode_with_compression_level<B: BufMut>( &self, buf: &mut B, level: Option<i32>, ) -> Result<(), RecordsError>

Encode this batch into buf, and compress the records at level.

None uses the default level of the codec, as Self::encode does. A producer passes its compression.<codec>.level setting (KIP-390). See krabka_compression::compress_with_level for how each codec applies the level.

Errors

Returns RecordsError::Compression when level is not a level that Kafka accepts for the codec of the batch attributes, including any level for a batch with no compression. Returns the other errors of Self::encode.

pub fn encoded_len(&self) -> usize

Predicted total bytes that encode will write, for an uncompressed batch.

For a compressed batch, the actual size will differ.

Trait Implementations

impl Clone for RecordBatch

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordBatch

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

Formats the value using the given formatter.

impl Decode<'_> for RecordBatch

fn decode<B: Buf>(buf: &mut B, _version: i16) -> Result<Self, ProtocolError>

Errors

impl Default for RecordBatch

fn default() -> Self

Returns the “default value” for a type.

impl Encode for RecordBatch

fn encode<B: BufMut>( &self, buf: &mut B, _version: i16, ) -> Result<(), ProtocolError>

Errors

fn encoded_len(&self, _version: i16) -> usize

Size in bytes that encode will write.

impl Eq for RecordBatch

impl From<RecordBatch> for RecordsPayload

fn from(rb: RecordBatch) -> Self

Converts to this type from the input type.

impl PartialEq for RecordBatch

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RecordBatch