Struct Nested

pub struct Nested<I, O> { /* private fields */ }

One object encapsulated in another one.

Nesteds are constructed using the [NestedPacketBuilder::encapsulate] and Serializer::encapsulate methods.

When I: NestedPacketBuilder and O: NestedPacketBuilder, Nested<I, O> implements [NestedPacketBuilder]. When I: Serializer and O: NestedPacketBuilder, Nested<I, O> implements Serializer.

Implementations

impl<I, O> Nested<I, O>

pub fn into_inner(self) -> I

Consumes this Nested and returns the inner object, discarding the outer one.

pub fn into_outer(self) -> O

Consumes this Nested and returns the outer object, discarding the inner one.

pub fn inner(&self) -> &I

pub fn inner_mut(&mut self) -> &mut I

pub fn outer(&self) -> &O

pub fn outer_mut(&mut self) -> &mut O

Trait Implementations

impl<I: Clone, O: Clone> Clone for Nested<I, O>

fn clone(&self) -> Nested<I, O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug, O: Debug> Debug for Nested<I, O>

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

Formats the value using the given formatter.

impl<I: PartialEq, O: PartialEq> PartialEq for Nested<I, O>

fn eq(&self, other: &Nested<I, O>) -> 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<I: Serializer, O: PacketBuilder> Serializer for Nested<I, O>

type Buffer = <I as Serializer>::Buffer

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

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

Serializes this Serializer, producing a buffer.

fn serialize_new_buf<B: ReusableBuffer, A: BufferAlloc<B>>( &self, outer: PacketConstraints, alloc: A, ) -> Result<B, 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<I: Copy, O: Copy> Copy for Nested<I, O>

impl<I: Eq, O: Eq> Eq for Nested<I, O>

impl<I, O> StructuralPartialEq for Nested<I, O>