Struct framed::bytes::Sender

pub struct Sender<W: Write> { /* fields omitted */ }

Sends encoded frames over an inner std::io::Write instance.

Construct an instance using the method Config::to_sender

Methods

impl<W: Write> Sender<W>

pub fn into_inner(self) -> W

Consume this Sender and return the inner std::io::Write.

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

Flush all buffered data. Includes calling flush on the inner writer.

pub fn queue(&mut self, p: &Payload) -> Result<usize>

Queue the supplied payload for transmission.

This Sender may buffer the data indefinitely, as may the inner writer. To ensure all buffered data has been transmitted call flush.

See also: send

pub fn send(&mut self, p: &Payload) -> Result<usize>

Encode the supplied payload as a frame, write it to the inner writer, then flush.

Ensures the data has been transmitted before returning to the caller.

See also: queue