Struct PacketCodec 

pub struct PacketCodec;

Trait Implementations

impl Decoder for PacketCodec

fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Packet>>

Decodes a packet from the byte stream

Returns None if there aren’t enough bytes to form a complete packet.

The header is validated as soon as its 9 bytes have arrived, before any of the payload is buffered, so a peer cannot make the connection hold a frame larger than MAX_PAYLOAD_SIZE or one with a bad magic or version.

Errors

Returns ProtocolError::InvalidHeader for a wrong magic, ProtocolError::UnsupportedVersion for an unknown version, and ProtocolError::OversizedPacket for a declared length over MAX_PAYLOAD_SIZE.

type Item = Packet

The type of decoded frames.

type Error = ProtocolError

The type of unrecoverable frame decoding errors.

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 Encoder<Packet> for PacketCodec

fn encode(&mut self, packet: Packet, dst: &mut BytesMut) -> Result<()>

Encodes a packet into the byte stream

Errors

Returns ProtocolError::OversizedPacket if the payload is larger than MAX_PAYLOAD_SIZE, which the receiving side would reject.

type Error = ProtocolError

The type of encoding errors.