Struct flussab::ByteWriter

pub struct ByteWriter<'a> { /* fields omitted */ }

A buffered writer with deferred error checking.

This can be used like std::io::BufWriter, but like ByteReader this performs deferred error checking. This means that any call to write, will always succeed. IO errors that occur during writing will be reported during the next call to flush or check_io_error. Any data written after an IO error occured, before it is eventually reported, will be discarded.

Deferring error checks like this can result in a significant speed up for some usage patterns.

Implementations

impl<'a> ByteWriter<'a>

pub fn from_write(write: impl Write + 'a) -> Self

Creates a ByteWriter writing data to a Write instance.

pub fn from_boxed_dyn_write(write: Box<dyn Write + 'a>) -> Self

Creates a ByteWriter writing data to a boxed Write instance.

pub fn flush_defer_err(&mut self)

Flush the buffered data to the underlying Write instance, deferring IO errors.

pub fn write_all_defer_err(&mut self, buf: &[u8])

Write a slice of bytes, deferring IO errors.

Both, write and write_all directly call this method. Unlike them, this does not return a #[must_use] value, making it clear that this cannot return an error.

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

Returns an encountered IO errors as Err(io_err).

This resets the stored IO error and returns Ok(()) if no IO error is stored.

Trait Implementations

impl<'a> Drop for ByteWriter<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Write for ByteWriter<'a>

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

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

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

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

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

Attempts to write an entire buffer into this writer.

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

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

pub 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.

pub 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.

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

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

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

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