Struct SlipWriter 

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

Writer wrapper that encodes outgoing frames as SLIP before forwarding them to the underlying writer.

The wrapper does not buffer beyond the escaping that SLIP requires. Each call to write_frame appends a single SLIP frame to the wrapped writer. See examples/stream.rs for a runnable demonstration.

Implementations

impl<W> SlipWriter<W>

pub fn new(inner: W) -> Self

Construct a new SLIP writer around the provided sink.

pub fn get_ref(&self) -> &W

Retrieve an immutable reference to the underlying writer.

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

Retrieve a mutable reference to the underlying writer.

pub fn into_inner(self) -> W

Consume the wrapper and return the inner writer.

impl<W: Write> SlipWriter<W>

pub fn write_frame(&mut self, payload: &[u8]) -> Result<()>

Encode the provided payload as a SLIP frame and write it to the underlying sink.

pub fn write_frame_iter<I>(&mut self, payload: I) -> Result<()>

where I: IntoIterator<Item = u8>,

Encode any iterator of bytes as a SLIP frame and write it to the underlying sink.

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

Flush the underlying writer.