Struct io_extras::borrowed::BorrowedReadable

#[repr(transparent)]
pub struct BorrowedReadable<'a> { /* private fields */ }

An owning I/O handle that implements Read.

This doesn’t implement Into* or From* traits.

Platform-specific behavior

On Posix-ish platforms, this reads from the handle as if it were a [File]. On Windows, this reads from a file-like handle as if it were a [File], and from a socket-like handle as if it were a TcpStream.

Implementations

impl<'a> BorrowedReadable<'a>

pub fn borrow(grip: BorrowedGrip<'a>) -> Self

Create a BorrowedReadable that can read from a BorrowedGrip.

Trait Implementations

impl<'a> AsFd for BorrowedReadable<'a>

BorrowedReadable borrows its handle.

fn as_fd(&self) -> BorrowedFd<'a>

Borrows the file descriptor.

impl<'a> Debug for BorrowedReadable<'a>

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

Formats the value using the given formatter.

impl<'a> Read for BorrowedReadable<'a>

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>

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>

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

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

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

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

Read 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)

Read the exact number of bytes required to fill cursor.

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 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.