Struct TruncatingSerializer

pub struct TruncatingSerializer<B> { /* private fields */ }

A Serializer that truncates its body if it would exceed a size limit.

TruncatingSerializer wraps a buffer, and implements Serializer. Unlike the blanket impl of Serializer for B: GrowBuffer + ShrinkBuffer, if the buffer’s body exceeds the size limit constraint passed to Serializer::serialize, the body is truncated to fit.

Note that this does not guarantee that size limit exceeded errors will not occur. The size limit may be small enough that the encapsulating headers alone exceed the size limit. There may also be a minimum body length constraint which is larger than the size limit.

Implementations

impl<B> TruncatingSerializer<B>

pub fn new(buffer: B, direction: TruncateDirection) -> TruncatingSerializer<B>

Constructs a new TruncatingSerializer.

Trait Implementations

impl<B: Clone> Clone for TruncatingSerializer<B>

fn clone(&self) -> TruncatingSerializer<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug> Debug for TruncatingSerializer<B>

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

Formats the value using the given formatter.

impl<B: GrowBuffer + ShrinkBuffer> Serializer for TruncatingSerializer<B>

type Buffer = B

The type of buffers returned from serialization methods on this trait.

fn serialize<BB: GrowBufferMut, P: BufferProvider<B, BB>>( self, outer: PacketConstraints, provider: P, ) -> Result<BB, (SerializeError<P::Error>, Self)>

Serializes this Serializer, producing a buffer.

fn serialize_new_buf<BB: ReusableBuffer, A: BufferAlloc<BB>>( &self, outer: PacketConstraints, alloc: A, ) -> Result<BB, SerializeError<A::Error>>

Serializes the data into a new buffer without consuming self.

fn serialize_vec( self, outer: PacketConstraints, ) -> Result<Either<Self::Buffer, Buf<Vec<u8>>>, (SerializeError<Never>, Self)>

where Self::Buffer: ReusableBuffer,

Serializes this Serializer, allocating a Buf<Vec<u8>> if the contained buffer isn’t large enough.

fn serialize_no_alloc( self, outer: PacketConstraints, ) -> Result<Self::Buffer, (SerializeError<BufferTooShortError>, Self)>

where Self::Buffer: ReusableBuffer,

Serializes this Serializer, failing if the existing buffer is not large enough.

fn serialize_outer<B: GrowBufferMut, P: BufferProvider<Self::Buffer, B>>( self, provider: P, ) -> Result<B, (SerializeError<P::Error>, Self)>

Serializes this Serializer as the outermost packet.

fn serialize_vec_outer( self, ) -> Result<Either<Self::Buffer, Buf<Vec<u8>>>, (SerializeError<Never>, Self)>

where Self::Buffer: ReusableBuffer,

Serializes this Serializer as the outermost packet, allocating a Buf<Vec<u8>> if the contained buffer isn’t large enough.

fn serialize_no_alloc_outer( self, ) -> Result<Self::Buffer, (SerializeError<BufferTooShortError>, Self)>

where Self::Buffer: ReusableBuffer,

Serializes this Serializer as the outermost packet, failing if the existing buffer is not large enough.

fn encapsulate<B>(self, outer: B) -> Nested<Self, B>

Encapsulates this Serializer in another packet, producing a new Serializer.

fn with_size_limit(self, limit: usize) -> Nested<Self, LimitedSizePacketBuilder>

Creates a new Serializer which will enforce a size limit.

impl<B: Copy> Copy for TruncatingSerializer<B>