Struct HeapReader

pub struct HeapReader { /* private fields */ }

Reader for reading from a heap-allocated bytes buffer.

Implementations

impl HeapReader

pub const fn new(data: Vec<u8>) -> HeapReader

Creates a new HeapReader with the specified bytes data.

pub fn remaining(&self) -> usize

How many bytes are there remaining

pub fn has_remaining(&self) -> bool

Returns true if there are any more bytes to consume

Trait Implementations

impl AsyncBufRead for HeapReader

fn poll_fill_buf( self: Pin<&mut HeapReader>, cx: &mut Context<'_>, ) -> Poll<Result<&[u8], Error>>

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut HeapReader>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl AsyncRead for HeapReader

fn poll_read( self: Pin<&mut HeapReader>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<(), Error>>

Attempts to read from the AsyncRead into buf.

impl Clone for HeapReader

fn clone(&self) -> HeapReader

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HeapReader

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

Formats the value using the given formatter.

impl Default for HeapReader

fn default() -> HeapReader

Returns the “default value” for a type.

impl From<&[u8]> for HeapReader

fn from(data: &[u8]) -> HeapReader

Converts to this type from the input type.

impl From<&str> for HeapReader

fn from(data: &str) -> HeapReader

Converts to this type from the input type.

impl From<Bytes> for HeapReader

fn from(data: Bytes) -> HeapReader

Converts to this type from the input type.

impl From<Vec<u8>> for HeapReader

fn from(data: Vec<u8>) -> HeapReader

Converts to this type from the input type.

impl Read for HeapReader

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

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.

impl<'__pin> Unpin for HeapReader

where <PinnedFieldsOfHelperStruct<__Origin<'__pin>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,