Module codecs::decoding::framing

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

Structs

• BytesDecoder
  A decoder for passing through bytes as-is.
• BytesDecoderConfig
  Config used to build a BytesDecoderConfig.
• CharacterDelimitedDecoder
  A decoder for handling bytes that are delimited by (a) chosen character(s).
• CharacterDelimitedDecoderConfig
  Config used to build a CharacterDelimitedDecoder.
• CharacterDelimitedDecoderOptions
  Options for building a CharacterDelimitedDecoder.
• ChunkedGelfDecoder
  A codec for handling GELF messages that may be chunked. The implementation is based on Graylog’s GELF documentation and Graylog’s go-gelf library.
• ChunkedGelfDecoderConfig
  Config used to build a ChunkedGelfDecoder.
• ChunkedGelfDecoderOptions
  Options for building a ChunkedGelfDecoder.
• LengthDelimitedDecoder
  A codec for handling bytes sequences whose length is encoded in a frame head.
• LengthDelimitedDecoderConfig
  Config used to build a LengthDelimitedDecoder.
• NewlineDelimitedDecoder
  A codec for handling bytes that are delimited by (a) newline(s).
• NewlineDelimitedDecoderConfig
  Config used to build a NewlineDelimitedDecoder.
• NewlineDelimitedDecoderOptions
  Options for building a NewlineDelimitedDecoder.
• OctetCountingDecoder
  Codec using the Octet Counting format as specified in https://tools.ietf.org/html/rfc6587#section-3.4.1.
• OctetCountingDecoderConfig
  Config used to build a OctetCountingDecoder.
• OctetCountingDecoderOptions
  Options for building a OctetCountingDecoder.

Traits

• Framer
  Produce byte frames from a byte stream / byte message.
• FramingError
  An error that occurred while producing byte frames from a byte stream / byte message.

Type Aliases

• BoxedFramer
  A Box containing a Framer.
• BoxedFramingError
  A Box containing a FramingError.