Module framing

Source
Expand description

A collection of framing methods that can be used to convert from byte chunks to byte frames with defined boundaries.

Structs§

BytesEncoder
An encoder for handling of plain bytes.
BytesEncoderConfig
Config used to build a BytesEncoder.
CharacterDelimitedEncoder
An encoder for handling bytes that are delimited by (a) chosen character(s).
CharacterDelimitedEncoderConfig
Config used to build a CharacterDelimitedEncoder.
CharacterDelimitedEncoderOptions
Configuration for character-delimited framing.
LengthDelimitedEncoder
An encoder for handling bytes that are delimited by a length header.
LengthDelimitedEncoderConfig
Config used to build a LengthDelimitedEncoder.
NewlineDelimitedEncoder
A codec for handling bytes that are delimited by (a) newline(s).
NewlineDelimitedEncoderConfig
Config used to build a NewlineDelimitedEncoder.
VarintLengthDelimitedEncoder
A codec for handling bytes sequences whose length is encoded as a varint prefix. This is compatible with protobuf’s length-delimited encoding.
VarintLengthDelimitedEncoderConfig
Config used to build a VarintLengthDelimitedEncoder.

Enums§

Framer
Produce a byte stream from byte frames.
FramingConfig
Framing configuration.

Traits§

FramingEncoder
Trait for types that can encode bytes with frame boundaries.
FramingError
An error that occurred while framing bytes.

Type Aliases§

BoxedFramer
A boxed FramingEncoder trait object.
BoxedFramingError
A Box containing a FramingError.