Struct FrameDecoder 

pub struct FrameDecoder { /* private fields */ }

Splits a byte stream into packets.

Implementations

impl FrameDecoder

pub fn new() -> Self

A decoder with no compression, no encryption, default limits and no filter.

pub fn set_limits(&mut self, limits: FrameLimits)

Sets the limits.

pub fn set_compression(&mut self, threshold: i32)

Turns compression on or off (from the server’s Set Compression packet; a negative threshold means off). Call it right after decoding that packet.

pub fn compression(&self) -> bool

Whether compression is on.

pub fn enable_encryption(&mut self, secret: &[u8; 16])

Turns on decryption. Bytes already buffered but not yet split into frames are decrypted too, since the server encrypts everything after its encryption request was answered.

pub fn is_encrypted(&self) -> bool

Whether decryption is on.

pub fn set_filter(&mut self, filter: PacketFilter)

Sets the per-id interest filter.

pub fn filter(&self) -> &PacketFilter

The current filter.

pub fn stats(&self) -> DecoderStats

Counters.

pub fn buffered(&self) -> usize

Number of buffered, not yet consumed bytes.

pub fn push(&mut self, data: &[u8])

Appends received bytes (decrypting them if encryption is on).

pub fn buffer_mut(&mut self) -> &mut BytesMut

The receive buffer, for reading directly into it. After appending n bytes call FrameDecoder::commit with the length before the read.

pub fn commit(&mut self, old_len: usize)

Decrypts bytes appended to FrameDecoder::buffer_mut since old_len.

pub fn needed(&self) -> Option<usize>

How many more bytes are needed to complete the next frame, if known.

pub fn next_packet(&mut self) -> Result<Option<RawPacket>, FrameError>

Splits off the next packet that passes the filter.

Returns Ok(None) when more bytes are needed. Errors are fatal for the connection (the stream position is lost).

Trait Implementations

impl Debug for FrameDecoder

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

Formats the value using the given formatter.

impl Default for FrameDecoder

fn default() -> Self

Returns the “default value” for a type.