Enum RecordsPayload 

pub enum RecordsPayload {
    V2(Vec<RecordBatch>),
    Raw(Bytes),
    Legacy(Bytes),
}

Owned form of a records-field payload.

Variants

V2(Vec<RecordBatch>)

Zero or more parsed v2 batches (the records field is a sequence).

Raw(Bytes)

Verbatim, already-wire-format v2 bytes (one or more batches), forwarded without parsing. Produced by the fetch pass-through path.

Legacy(Bytes)

Opaque pre-v2 bytes (v0/v1 MessageSet). Decode with crabka_records_legacy::decode_message_set.

Implementations

impl RecordsPayload

pub fn from_bytes(bytes: Bytes) -> Result<Self, RecordsError>

Construct from raw records-field bytes. When the bytes look like v2, decode every batch in the field; otherwise keep as opaque legacy.

pub fn payload_len(&self) -> usize

Wire size of the records-field bytes (no outer length prefix).

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

Write the payload bytes into buf (caller owns the outer framing).

pub fn as_v2(&self) -> Option<&[RecordBatch]>

Borrow the parsed v2 batches, if this is a parsed V2 payload. Returns None for Raw (intentionally unparsed) and Legacy.

pub fn as_legacy(&self) -> Option<&Bytes>

Borrow as raw legacy bytes, if that’s what this payload is.

pub fn from_fetch_bytes(bytes: Bytes) -> Result<Self, RecordsError>

Decode a response-side records field, tolerating a truncated trailing batch. Kafka returns a partial final RecordBatch when a partition’s fetch byte budget is hit mid-batch; the JVM consumer stops at the first incomplete batch and re-fetches it from the next offset. We mirror that: decode every complete batch, and on the first HeaderTooShort / BodyTooShort stop and drop the remainder. A corrupt complete batch (bad CRC/magic/content) still errors — leniency forgives truncation only. Strict from_bytes is retained for Produce-request validation.

Only HeaderTooShort/BodyTooShort are treated as truncation; a genuinely invalid batch_length (RecordParse) is corruption and still errors — legitimate Kafka truncation always preserves a valid batch_length prefix, so it can only manifest as the too-short variants.

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

Decode-shaped lenient entry point the generated codec calls for records fields in response messages. Consumes the whole sliced field buffer (the caller has already framed it) and parses leniently via from_fetch_bytes.

Trait Implementations

impl Clone for RecordsPayload

fn clone(&self) -> RecordsPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordsPayload

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

Formats the value using the given formatter.

impl Decode<'_> for RecordsPayload

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

impl Default for RecordsPayload

fn default() -> Self

Returns the “default value” for a type.

impl Encode for RecordsPayload

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

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

Size in bytes that encode will write. Must equal the actual count.

impl Eq for RecordsPayload

impl From<RecordBatch> for RecordsPayload

fn from(rb: RecordBatch) -> Self

Converts to this type from the input type.

impl From<Vec<RecordBatch>> for RecordsPayload

fn from(v: Vec<RecordBatch>) -> Self

Converts to this type from the input type.

impl PartialEq for RecordsPayload

fn eq(&self, other: &RecordsPayload) -> 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 StructuralPartialEq for RecordsPayload