Struct iowrap::ShortRead

pub struct ShortRead<R: Read, I: Iterator<Item = usize>> { /* fields omitted */ }

Intentionally return short reads, to test Read code.

The decider iterator gets to decide how short a read should be. Currently, no effort is made to make reads longer, if the underlying reader naturally returns short reads.

It's expected that the sum of the iterator is longer than the reader: the behaviour otherwise hasn't yet been decided.

Example

let mut naughty = iowrap::ShortRead::new(
        io::Cursor::new(b"1234567890"),
        vec![2, 3, 4, 5, 6].into_iter()
);
let mut buf = [0u8; 10];
// A `Cursor` would normally return the whole ten bytes here,
// but we've limited it to two bytes.
assert_eq!(2, naughty.read(&mut buf).unwrap());

Methods

impl<R: Read, I: Iterator<Item = usize>> ShortRead<R, I>

fn new(inner: R, decider: I) -> Self

fn into_inner(self) -> R

Trait Implementations

impl<R: Read, I: Iterator<Item = usize>> Read for ShortRead<R, I>

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.

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, 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 [char]s.

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.