Struct RecordSequenceBuilder

pub struct RecordSequenceBuilder<R, I> { /* private fields */ }

A builder capable of serializing a sequence of records.

A RecordSequenceBuilder is instantiated with an Iterator that provides RecordBuilders to be serialized. The item produced by the iterator can be any type which implements Borrow<R> for R: RecordBuilder.

RecordSequenceBuilder implements InnerPacketBuilder.

Implementations

impl<R, I> RecordSequenceBuilder<R, I>

pub fn new(records: I) -> Self

Creates a new RecordSequenceBuilder with the given records.

records must produce the same sequence of values from every iteration, even if cloned. Serialization is typically performed with two passes on records: one to calculate the total length in bytes (serialized_len) and another one to serialize to a buffer (serialize_into). Violating this rule may result in panics or malformed serialized record sequences.

impl<R, I> RecordSequenceBuilder<R, I>

where R: RecordBuilder, I: Iterator + Clone, I::Item: Borrow<R>,

pub fn serialized_len(&self) -> usize

Returns the total length, in bytes, of the serialized encoding of the records contained within self.

pub fn serialize_into(&self, buffer: &mut [u8])

Serializes all the records contained within self into the given buffer.

Panics

serialize_into expects that buffer has enough bytes to serialize the contained records (as obtained from serialized_len), otherwise it’s considered a violation of the API contract and the call may panic.

pub fn records(&self) -> &I

Returns a reference to the inner records of this builder.

Trait Implementations

impl<R: Clone, I: Clone> Clone for RecordSequenceBuilder<R, I>

fn clone(&self) -> RecordSequenceBuilder<R, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug, I: Debug> Debug for RecordSequenceBuilder<R, I>

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

Formats the value using the given formatter.

impl<R, I> InnerPacketBuilder for RecordSequenceBuilder<R, I>

where R: RecordBuilder, I: Iterator + Clone, I::Item: Borrow<R>,

fn bytes_len(&self) -> usize

The number of bytes consumed by this packet.

fn serialize(&self, buffer: &mut [u8])

Serializes this packet into an existing buffer.

fn into_serializer(self) -> InnerSerializer<Self, EmptyBuf>

where Self: Sized,

Converts this InnerPacketBuilder into a Serializer.

fn into_serializer_with<B: ShrinkBuffer>( self, buffer: B, ) -> InnerSerializer<Self, B>

where Self: Sized,

Converts this InnerPacketBuilder into a Serializer with a buffer that can be used for serialization.