Struct IntegrityCodec

pub struct IntegrityCodec { /* private fields */ }

A codec for frames delimited by a header specifying their lengths, sequence number and checksums.

The data integrity is verified using the CRC32 checksum.

Implementations

impl IntegrityCodec

pub fn new() -> Self

Creates a new IntegrityCodec with the default configuration values.

pub fn max_packet_size(&self) -> u32

Returns the maximum packet size.

This is the largest size this codec will accept from the wire. Larger packets will be rejected.

pub fn set_max_packet_size(&mut self, max_packet_size: u32)

Sets the maximum packet size.

This is the largest size this codec will accept from and send to the wire. Larger packets will be rejected.

Trait Implementations

impl Clone for IntegrityCodec

fn clone(&self) -> IntegrityCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IntegrityCodec

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

Formats the value using the given formatter.

impl Decoder for IntegrityCodec

type Item = BytesMut

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

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

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 IntegrityCodec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<Bytes> for IntegrityCodec

type Error = Error

The type of encoding errors.

fn encode(&mut self, data: Bytes, dst: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided.