Struct Writer

pub struct Writer<T> { /* private fields */ }

Available on crate feature blocking-io and (crate features async-io or blocking-io) only.

An implementor of Write which passes all input to an inner Write in packet line data encoding, one line per write(…) call or as many lines as it takes if the data doesn’t fit into the maximum allowed line length.

Implementations

impl<T: Write> Writer<T>

pub fn new(write: T) -> Self

Create a new instance from the given write

impl<T> Writer<T>

Non-IO methods

pub fn enable_binary_mode(&mut self)

If called, each call to write() will write bytes as is.

pub fn enable_text_mode(&mut self)

If called, each call to write() will write the input as text, appending a trailing newline if needed before writing.

pub fn into_inner(self) -> T

Return the inner writer, consuming self.

pub fn inner_mut(&mut self) -> &mut T

Return a mutable reference to the inner writer, useful if packet lines should be serialized directly.

impl<T> Writer<T>

Common methods

pub fn text_mode(self) -> Self

As enable_text_mode(), but suitable for chaining.

pub fn binary_mode(self) -> Self

As enable_binary_mode(), but suitable for chaining.

Trait Implementations

impl<T: Write> Write for Writer<T>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.