Struct FrameCodec 

pub struct FrameCodec { /* private fields */ }

Length-delimited codec for SDK–Gateway Frame values.

The configured limit applies to the frame payload and excludes the fixed wire header.

Implementations

impl FrameCodec

pub const fn new(max_frame_len: usize) -> Self

Creates a codec that rejects payloads longer than max_frame_len bytes.

Trait Implementations

impl Clone for FrameCodec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameCodec

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

Formats the value using the given formatter.

impl Decoder for FrameCodec

type Item = Frame

The type of decoded frames.

type Error = ProtocolError

The type of unrecoverable frame decoding errors.

fn decode( &mut self, source: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Default for FrameCodec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<Frame> for FrameCodec

type Error = ProtocolError

The type of encoding errors.

fn encode( &mut self, item: Frame, destination: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.