Struct input_stream::InputStream

pub struct InputStream<T: BufRead> { /* fields omitted */ }

A wrapper for std::io::BufRead.

To get an instance of this struct use static method new on InputStream.

Methods

impl<T: BufRead> InputStream<T>

Important traits for InputStream<T>

impl<T: BufRead> Read for InputStream<T>

pub fn new(reader: T) -> InputStream<T>

Creates an instance of InputStream which wraps the given std::io::BufRead.

pub fn scan<F: FromStr>(&mut self) -> Result<F>

Scan the underlying buffered reader for a value of a type that implements std::str::FromStr returning a Result.

An example on how to use scan is at the crate documentation.

pub fn scan_with_limit<F: FromStr>(&mut self, limit: usize) -> Result<F>

Scan the underlying buffer reader for a value of a type that implements std::str::FromStr returning a Result.

This is a refined version of scan which allows limits to be placed on the maximum size of the internal buffer

Trait Implementations

impl<T: Debug + BufRead> Debug for InputStream<T>

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

Formats the value using the given formatter.

impl<T: BufRead> BufRead for InputStream<T>

fn fill_buf(&mut self) -> Result<&[u8]>

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

fn consume(&mut self, amount: usize)

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

fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes into buf until the delimiter byte or EOF is reached.

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

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl<T: BufRead> Read for InputStream<T>

fn read(&mut self, buffer: &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, 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.