Struct layered_io::LayeredWriter

pub struct LayeredWriter<Inner> { /* private fields */ }

Adapts a std::io::Write to implement WriteLayered.

Implementations

impl<Inner: Write> LayeredWriter<Inner>

pub fn new(inner: Inner) -> Self

Construct a new LayeredWriter which wraps inner.

pub fn get_ref(&self) -> &Inner

Gets a reference to the underlying writer.

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

Gets a mutable reference to the underlying writer.

It is inadvisable to directly write to the underlying writer.

pub fn close_into_inner(self) -> Result<Inner>

Close this LayeredWriter and return the inner stream.

pub fn abandon_into_inner(self) -> Option<Inner>

Consume this LayeredWriter and return the inner stream.

Trait Implementations

impl<Inner: Write + AsFd> AsFd for LayeredWriter<Inner>

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl<Inner: Write + AsRawFd> AsRawFd for LayeredWriter<Inner>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<Inner> Bufferable for LayeredWriter<Inner>

fn abandon(&mut self)

Close the resource and abandon any pending buffered contents or errors.

fn suggested_buffer_size(&self) -> usize

A suggested size, in bytes, for buffering for performance.

impl<Inner: Debug> Debug for LayeredWriter<Inner>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Inner> Drop for LayeredWriter<Inner>

fn drop(&mut self)

Executes the destructor for this type.

impl<Inner: Write> Write for LayeredWriter<Inner>

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_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

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<()>

Attempts to write an entire buffer into this writer.

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

🔬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<()>

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

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

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

impl<Inner: Write> WriteLayered for LayeredWriter<Inner>

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

Flush any buffers and declare the end of the stream. Subsequent writes will fail.

fn flush_with_status(&mut self, status: Status) -> Result<()>

Like Write::flush, but has a status parameter describing the future of the stream: