Struct bytecodec::io::ReadBuf

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

Read buffer.

Methods

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

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn inner_ref(&self) -> &B

Returns a reference to the inner bytes of the buffer.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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.

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.

unsafe fn initializer(&self) -> Initializer

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

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

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> 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.

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

Read the exact number of bytes required to fill buf.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Creates a "by reference" adaptor for this instance of Read.

Important traits for Bytes<R>

impl<R> Iterator for Bytes<R> where
    R: Read,  type Item = Result<u8, Error>;

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

Important traits for Chars<R>

impl<R> Iterator for Chars<R> where
    R: Read,  type Item = Result<char, CharsError>;

fn chars(self) -> Chars<Self>

Deprecated since 1.27.0

: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

Important traits for Chain<T, U>

impl<T, U> Read for Chain<T, U> where
    T: Read,
    U: Read, 

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

Creates an adaptor which will chain this stream with another.

Important traits for Take<T>

impl<T> Read for Take<T> where
    T: Read, 

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

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