Struct FrameEncoder 

pub struct FrameEncoder { /* private fields */ }

Turns packets into wire bytes. Packets are appended to an internal output buffer; take it with FrameEncoder::take (or let crate::io::FramedWriter flush it), so several packets of one tick go out in a single write.

Implementations

impl FrameEncoder

pub fn new() -> Self

An encoder with no compression and no encryption.

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

Sets the compression threshold (negative = off), as received from the server.

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

Turns on encryption for everything written from now on.

pub fn write_packet<P: Packet>(&mut self, p: &P) -> Result<(), EncodeError>

Encodes and frames a typed packet.

pub fn write_set<S: PacketSet>(&mut self, p: &S) -> Result<(), EncodeError>

Encodes and frames a packet-set enum value.

pub fn write_raw(&mut self, p: &RawPacket) -> Result<(), EncodeError>

Frames a raw packet.

pub fn pending(&self) -> &[u8]

Bytes waiting to be sent.

pub fn take(&mut self) -> BytesMut

Takes the bytes waiting to be sent.

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

The output buffer (for transports that consume it in place).

Trait Implementations

impl Debug for FrameEncoder

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

Formats the value using the given formatter.

impl Default for FrameEncoder

fn default() -> Self

Returns the “default value” for a type.