Struct stdio::StdioReadGuard

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

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

Implementations

impl<'a> StdioReadGuard<'a>

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

Same as read(), but is non-blocking.

Returns Ok(0) when the underlying buffer is empty.

pub fn remaining_bytes(&self) -> usize

Returns the number of bytes still in the read buffer.

impl<'a> StdioReadGuard<'a>

pub fn is_eof(&self) -> bool

Check if the EOF flag of the queue has been set.

Trait Implementations

impl<'a> Read for StdioReadGuard<'a>

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

Read from the ring buffer. Returns the number of bytes read.

Currently it is not possible to return an error, but one should not assume that because it is subject to change in the future.

Note that this method will block until at least one byte is available to be read. It will only return zero under one of two scenarios:

1. The EOF flag has been set.
2. The buffer specified was 0 bytes in length.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

unsafe fn initializer(&self) -> Initializer

Determines if this Reader can work with buffers of uninitialized memory.

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

Read the exact number of bytes required to fill buf.

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

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

fn bytes(self) -> Bytes<Self>where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>where R: Read, Self: Sized,

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>where Self: Sized,

Creates an adaptor which will read at most limit bytes from it.