Struct mz_persist_client::internal::state_diff::ProtoStateFieldDiffsWriter

pub struct ProtoStateFieldDiffsWriter {
    data_buf: BytesMut,
    proto: ProtoStateFieldDiffs,
}

A type that facilitates the proto encoding of a ProtoStateFieldDiffs

ProtoStateFieldDiffs is a columnar encoding of StateFieldDiffs, see its doc comment for more info. The underlying buffer for a ProtoStateFieldDiffs is a Bytes struct, which is an immutable, shared, reference counted, buffer of data. Using a Bytes struct is a very efficient way to manage data becuase multiple Bytes can reference different parts of the same underlying portion of memory. See its doc comment for more info.

A ProtoStateFieldDiffsWriter maintains a mutable, unique, data buffer, i.e. a BytesMut, which we use when encoding a StateFieldDiff. And when finished encoding, we convert it into a ProtoStateFieldDiffs by “freezing” the underlying buffer, converting it into a Bytes struct, so it can be shared.

Fields

data_buf: BytesMut

proto: ProtoStateFieldDiffs

Implementations

impl ProtoStateFieldDiffsWriter

pub fn push_field(&mut self, field: ProtoStateField)

Record a ProtoStateField for our columnar encoding.

pub fn push_diff_type(&mut self, diff_type: ProtoStateFieldDiffType)

Record a ProtoStateFieldDiffType for our columnar encoding.

pub fn encode_proto<M: Message>(&mut self, msg: &M)

Encode a message for our columnar encoding.

pub fn into_proto(self) -> ProtoStateFieldDiffs

Trait Implementations

impl Debug for ProtoStateFieldDiffsWriter

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

Formats the value using the given formatter.