Struct ProtoIdBatch

pub struct ProtoIdBatch {
    pub batch_id: Bytes,
    pub batch: Option<ProtoBatch>,
}

A wrapper for ProtoBatch with an id to ensure that each unique batch’s serialization is unique.

Fields

batch_id: Bytes

batch: Option<ProtoBatch>

We reserved 4 in ProtoBatch so that we can use the presence of this field as a sentinel for whether txn-wal has encoded a batch as ProtoIdBatch or (the legacy) ProtoBatch.

Implementations

impl ProtoIdBatch

pub(crate) fn new(batch: ProtoBatch) -> ProtoIdBatch

pub(crate) fn parse(buf: &[u8]) -> ProtoBatch

Recovers the ProtoBatch from an encoded batch.

This might be an encoded ProtoIdBatch (new path) or a ProtoBatch (legacy path). Some proto shenanigans are done to sniff out which.

Trait Implementations

impl Clone for ProtoIdBatch

fn clone(&self) -> ProtoIdBatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtoIdBatch

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

Formats the value using the given formatter.

impl Default for ProtoIdBatch

fn default() -> Self

Returns the “default value” for a type.

impl Message for ProtoIdBatch

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ProtoIdBatch

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