Struct netio::Take

pub struct Take<T> {
    // some fields omitted
}

Adapter which limits the bytes read from / written to an underlying reader / writer.

This struct is generally created by calling take() on a reader/writer. Please see the documentation of Read::take and Write::take for more details.

Methods

impl<T> Take<T>

fn new(inner: T, limit: u64) -> Take<T>

fn limit(&self) -> u64

Returns the number of bytes that can be read before this instance will return EOF.

Note

This instance may reach EOF after reading fewer bytes than indicated by this method if the underlying Read instance reaches EOF.

Trait Implementations

impl<T: Read> Read for Take<T>

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_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, placing them into 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 chars(self) -> Chars<Self>

Unstable (io)

: the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

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.

impl<T: BufRead> BufRead for Take<T>

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

Fills the internal buffer of this object, returning the buffer contents.

fn consume(&mut self, amt: 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 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: BufReadGrow> BufReadGrow for Take<T>

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

Grows the internal buffer of this object by at least one byte, returning the buffer contents.

fn fill_buf_min(&mut self, size: usize) -> Result<&[u8]>

Fills the internal buffer to at least the specified amount, returning the buffer contents.

fn read_until2(&mut self, delims: (u8, u8), buf: &mut Vec<u8>) -> Result<()>

Read all bytes into a buffer until two consecutive delimiters are reached.

fn skip_until2(&mut self, delims: (u8, u8)) -> Result<()>

Skip all bytes until two consecutive delimiters are reached.

fn fill_buf_str(&mut self) -> Result<&str>

Fills the internal buffer of this object, returning the buffer content as a string

fn grow_buf_str(&mut self) -> Result<&str>

Grows the internal buffer of this object by at least one char, returning the buffer content as a string

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

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

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

Read all bytes until a CRLF is reached, and append them to the provided buffer.

fn chars(self) -> Chars<Self> where Self: Sized

Transforms this reader to an Iterator over chars.

impl<T: Write> Write for Take<T>

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

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

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