Struct PipeBufWriter

pub struct PipeBufWriter { /* private fields */ }

The Write end of a pipe (see pipe()) that will buffer small writes before sending to the reader end.

Implementations

impl PipeBufWriter

pub fn into_inner(self) -> (Sender<Vec<u8>>, Vec<u8>)

Extracts the inner Sender from the writer, and any pending buffered data

pub fn sender(&self) -> &Sender<Vec<u8>>

Gets a reference to the underlying Sender

pub fn buffer(&self) -> &[u8]

Returns a reference to the internally buffered data.

pub fn capacity(&self) -> usize

Returns the number of bytes the internal buffer can hold without flushing.

Trait Implementations

impl Clone for PipeBufWriter

Creates a new handle to the PipeBufWriter with a fresh new buffer. Any pending data is still owned by the existing writer and should be flushed if necessary.

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for PipeBufWriter

Flushes the contents of the buffer before the writer is dropped. Errors are ignored, so it is recommended that flush() be used explicitly instead of relying on Drop.

This final flush can be avoided by using drop(writer.into_inner()).

fn drop(&mut self)

Executes the destructor for this type.

impl Write for PipeBufWriter

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, args: 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.