Trait Read 

pub trait Read {
    // Required method
    fn read(&mut self, buf: &mut [u8]) -> Result<usize, IoError>;

    // Provided methods
    fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), IoError> { ... }
    fn read_buf(&mut self, buf: BorrowedCursor<'_, u8>) -> Result<(), IoError> { ... }
    fn read_buf_exact(
        &mut self,
        cursor: BorrowedCursor<'_, u8>,
    ) -> Result<(), IoError> { ... }
    fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, IoError> { ... }
    fn read_to_string(&mut self, buf: &mut String) -> Result<usize, IoError> { ... }
    fn by_ref(&mut self) -> &mut Self
       where Self: Sized { ... }
    fn chain<R>(self, next: R) -> Chain<Self, R>
       where R: Read,
             Self: Sized { ... }
    fn take(self, limit: u64) -> Take<Self>
       where Self: Sized { ... }
}

The Read trait allows for reading bytes from a source.

See [std::io::Read] for more details.

Required Methods

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

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

Provided Methods

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

Read the exact number of bytes required to fill buf.

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

Pull some bytes from this source into the specified buffer.

This method makes it possible to return both data and an error but it is advised against.

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

Reads the exact number of bytes required to fill cursor.

If this function returns an error, all bytes read will be appended to cursor.

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

Available on crate feature alloc only.

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

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

Available on crate feature alloc only.

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

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

where Self: Sized,

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

The returned adapter also implements Read and will simply borrow this current reader.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

The returned Read instance will first read all bytes from this object until EOF is encountered. Afterwards the output is equivalent to the output of next.

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

where Self: Sized,

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

This function returns a new instance of Read which will read at most limit bytes, after which it will always return EOF (Ok(0)). Any read errors will not count towards the number of bytes read and future calls to read() may succeed.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Read for &[u8]

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

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

fn read_buf(&mut self, cursor: BorrowedCursor<'_, u8>) -> Result<(), IoError>

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

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

Available on crate feature alloc only.

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

Available on crate feature alloc only.

impl Read for VecDeque<u8>

Available on crate feature alloc only.

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

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

fn read_buf(&mut self, cursor: BorrowedCursor<'_, u8>) -> Result<(), IoError>

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

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

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

impl<R> Read for &mut R

where R: Read + ?Sized,

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

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

fn read_buf(&mut self, cursor: BorrowedCursor<'_, u8>) -> Result<(), IoError>

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

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

Available on crate feature alloc only.

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

Available on crate feature alloc only.

impl<R> Read for Box<R>

where R: Read + ?Sized,

Available on crate feature alloc only.

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

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

fn read_buf(&mut self, cursor: BorrowedCursor<'_, u8>) -> Result<(), IoError>

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

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

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

Implementors

impl Read for Empty

impl Read for Repeat

impl Read for Stdin

impl Read for StdinLock<'_>

impl<R> Read for BufReader<R>

where R: Read + ?Sized,

impl<R> Read for ReadFn<R>

where R: FnMut(&mut [u8]) -> Result<usize, IoError>,

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

where T: Read, U: Read,

impl<T> Read for Cursor<T>

where T: AsRef<[u8]>,

impl<T> Read for Take<T>

where T: Read,