Struct FramedWriter 

pub struct FramedWriter<W> { /* private fields */ }

Writes packets to an AsyncWrite, batching until FramedWriter::flush.

Implementations

impl<W: AsyncWrite + Unpin> FramedWriter<W>

pub fn new(inner: W) -> Self

Wraps a writer.

pub fn encoder(&mut self) -> &mut FrameEncoder

The frame encoder (compression, encryption).

pub fn get_mut(&mut self) -> &mut W

The underlying writer.

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

Queues a typed packet (nothing is written until FramedWriter::flush).

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

Queues a packet-set value.

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

Queues a raw packet.

pub async fn flush(&mut self) -> Result<()>

Writes everything queued and flushes the writer.

Cancel safe in the sense that bytes already written are removed from the queue; a dropped flush can be resumed by calling it again.

pub async fn send<P: Packet>(&mut self, p: &P) -> Result<(), FrameError>

Queues a typed packet and flushes.

Trait Implementations

impl<W: Debug> Debug for FramedWriter<W>

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

Formats the value using the given formatter.