Struct ReadBuf

pub struct ReadBuf<B> { /* private fields */ }

Read buffer.

Implementations

impl<B: AsRef<[u8]> + AsMut<[u8]>> ReadBuf<B>

pub fn new(inner: B) -> Self

Makes a new ReadBuf instance.

pub fn len(&self) -> usize

Returns the number of filled bytes in the buffer.

pub fn room(&self) -> usize

Returns the free space of the buffer.

Invariant: self.len() + self.room() <= self.capacity()

pub fn capacity(&self) -> usize

Returns the capacity of the buffer.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty, otherwise false.

pub fn is_full(&self) -> bool

Returns true if the buffer is full, otherwise false.

pub fn stream_state(&self) -> StreamState

Returns the state of the stream that operated in the last fill() call.

pub fn stream_state_mut(&mut self) -> &mut StreamState

Returns a mutable reference to the StreamState instance.

pub fn fill<R: Read>(&mut self, reader: R) -> Result<()>

Fills the read buffer by reading bytes from the given reader.

The fill process continues until one of the following condition is satisfied:

• The read buffer became full
• A read operation returned a WouldBlock error
• The input stream has reached EOS

pub fn inner_ref(&self) -> &B

Returns a reference to the inner bytes of the buffer.

pub fn inner_mut(&mut self) -> &mut B

Returns a mutable reference to the inner bytes of the buffer.

pub fn into_inner(self) -> B

Takes ownership of ReadBuf and returns the inner bytes of the buffer.

impl<B: AsRef<[u8]> + AsMut<[u8]>> ReadBuf<B>

pub fn poll_fill<R: AsyncRead>( &mut self, reader: Pin<&mut R>, cx: &mut Context<'_>, ) -> Poll<Result<()>>

Fills the read buffer by reading bytes from the given reader.

The fill process continues until one of the following condition is satisfied:

• The read buffer became full
• A read operation returned a WouldBlock error
• The input stream has reached EOS

Trait Implementations

impl<B: Debug> Debug for ReadBuf<B>

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

Formats the value using the given formatter.

impl<B: AsRef<[u8]> + AsMut<[u8]>> Read for ReadBuf<B>

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

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

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

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

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

where 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 adapter which will chain this stream with another.

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

where Self: Sized,

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