Struct nue_io::Region

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

Creates an isolated segment of an underlying stream.

Seeks past the region will be capped, and reaching the end of the region will result in EOF when reading or writing.

Methods

impl<T> Region<T>

fn new(inner: T, start: u64, end: u64) -> Self

Creates a new Region at the specified offsets of inner.

fn region(&self) -> (u64, u64)

Returns the region bounds.

fn into_inner(self) -> T

Unwraps the Region to return the inner stream.

Trait Implementations

impl<T: Read + Tell + SeekAbsolute> Read for Region<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>

🔬 This is a nightly-only experimental API. (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: Write + Tell + SeekAbsolute> Write for Region<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.

impl<T: SeekAbsolute> SeekAbsolute for Region<T>

fn seek_absolute(&mut self, pos: u64) -> Result<u64>

Seeks to the specified position in the stream.

impl<T: SeekForward + Tell + SeekAbsolute> SeekForward for Region<T>

fn seek_forward(&mut self, offset: u64) -> Result<u64>

Seeks forward in the stream.

impl<T: Tell + SeekBackward> SeekBackward for Region<T>

fn seek_backward(&mut self, offset: u64) -> Result<u64>

Seeks backward in the stream.

impl<T: SeekAbsolute> SeekRewind for Region<T>

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

Seeks back to the beginning of the stream.

impl<T: SeekAbsolute> SeekEnd for Region<T>

fn seek_end(&mut self, offset: i64) -> Result<u64>

Seeks to the end of the stream + offset.

impl<T: Tell> Tell for Region<T>

fn tell(&mut self) -> Result<u64>

Returns the current absolute position in the stream.

impl<T: BufRead + Tell + SeekAbsolute> BufRead for Region<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 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.