Struct stdio::StdioWriteGuard

pub struct StdioWriteGuard<'a> { /* private fields */ }

StdioReadGuard acts like MutexGuard, it locks the underlying ring buffer during its lifetime, and provides writing methods to the ring buffer. The lock will be automatically released on dropping of this structure.

Implementations

impl<'a> StdioWriteGuard<'a>

pub fn set_eof(&mut self)

Set the EOF flag of the queue to true.

Trait Implementations

impl<'a> Write for StdioWriteGuard<'a>

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

Write to the ring buffer, returniong the number of bytes written.

When this method is called after setting the EOF flag, it returns error with ErrorKind set to UnexpectedEof.

Also note that this method does not guarantee to write all given bytes, although it currently does so. Always check the return value when using this method. Otherwise, use write_all to ensure that all given bytes are written.

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

The function required by Write trait. Currently it performs nothing, since everything is write directly to the ring buffer in write method.

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

Attempts to write an entire buffer 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 Selfwhere Self: Sized,

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