Struct neli::StreamReadBuffer

pub struct StreamReadBuffer<T> { /* fields omitted */ }

A stream reader that will allow piece-by-piece reading of a buffer

Methods

impl<T> StreamReadBuffer<T> where
    T: AsRef<[u8]>, 

Important traits for StreamReadBuffer<T>

impl<T> Read for StreamReadBuffer<T> where
    T: AsRef<[u8]>, 

pub fn new(buf: T) -> StreamReadBuffer<T>

Create a new reader with an underlying data type that can be expresssed as a byte slice

pub fn set_size_hint(&mut self, size_hint: usize)

Set size hint

pub fn has_size_hint(&self) -> bool

Return true if a size hint is present

pub fn take_size_hint(&mut self) -> Option<usize>

Replace size hint with None and return Some(size_hint)

pub fn peek_size_hint(&self) -> Option<usize>

Return size hint without changing the stream's size hint struct member

pub fn at_end(&self) -> bool

Check whether the stream has reached the end of the underlying buffer

pub fn rewind(&mut self)

If an error occurs, call this function to rewind to the point in the stream before the last read

pub fn set_at_end(&mut self)

Set cursor to end - this will effectively discard the remaining stream

Trait Implementations

impl<T> AsRef<[u8]> for StreamReadBuffer<T> where
    T: AsRef<[u8]>, 

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<T> Read for StreamReadBuffer<T> where
    T: AsRef<[u8]>, 

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.

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.

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

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

fn bytes(self) -> Bytes<Self>

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

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

Creates an adaptor which will chain this stream with another.

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

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