Expand description
Serialization.
Structs§
- Buf
- A byte slice wrapper providing buffer functionality.
- BufView
- A
BufferViewinto aBuf. - BufView
Mut - A
BufferViewMutinto aBuf. - Buffer
TooShort Error - The error returned when a buffer is too short to hold a serialized packet,
and the
BufferProvideris incapable of allocating a new one. - Byte
Slice Inner Packet Builder - An
InnerPacketBuildercreated from anyB: SplitByteSlice. - DynSerializer
- A type that provides
Serializervia dynamic dispatch. - Inner
Serializer - A
Serializerconstructed from anInnerPacketBuilder. - Limited
Size Packet Builder - A
PacketBuilderwhich has no header or footer, but which imposes a maximum body length constraint. - Maybe
Reuse Buffer Provider - Provides an implementation of
BufferProviderfrom aBufferAllocAthat attempts to reuse the input buffer and falls back to the allocator if the input buffer can’t be reused. - Nested
- One object encapsulated in another one.
- NoReuse
Buffer Provider - Provides an implementation of
BufferProviderfrom aBufferAllocAthat never attempts to reuse the input buffer, and always create a new buffer from the allocatorA. - Packet
Constraints - The constraints required by a
PacketBuilder. - Partial
Serialize Result - Result returned by
PartialSerializer::partial_serialize. - Serialize
Target - The target buffers into which
PacketBuilder::serializeserializes its header and footer. - Truncating
Serializer - A
Serializerthat truncates its body if it would exceed a size limit.
Enums§
- Either
- Either of two buffers.
- Either
Serializer - Either of two serializers.
- Serialize
Error - An error in serializing a packet.
- Truncate
Direction - The direction a buffer’s body should be truncated from to force it to fit within a size limit.
Traits§
- Buffer
Alloc - An object capable of allocating new buffers.
- Buffer
Provider - An object capable of providing buffers which satisfy certain constraints.
- Dynamic
Serializer - A marker trait that is used as an attestation of dynamic serialization capabilities.
- Inner
Packet Builder - A builder capable of serializing packets - which do not encapsulate other packets - into an existing buffer.
- Layout
Buffer Alloc - A variant of
BufferAllocthat allocates buffers with the necessary prefix, body, suffix layout. - Packet
Builder - A builder capable of serializing a packet’s headers and footers.
- Partial
Packet Builder - A packet builder used for partial packet serialization.
- Partial
Serializer - A serializer that supports partial serialization.
- Serializer
Functions§
- new_
buf_ vec - Allocates a new
Buf<Vec<u8>>. - try_
reuse_ buffer - Attempts to reuse a buffer for the purposes of implementing
BufferProvider::reuse_or_realloc.