Struct timeout_readwrite::TimeoutReader

pub struct TimeoutReader<H> where
    H: Read + AsRawFd,  { /* fields omitted */ }

The TimeoutReader struct adds read timeouts to any reader.

The read call on a Read instance will block forever until data is available. A TimeoutReader will wait until data is available, up until an optional timeout, before actually performing the read operation.

Methods

impl<H> TimeoutReader<H> where
    H: Read + AsRawFd, 

fn new<T: Into<Option<Duration>>>(handle: H, timeout: T) -> TimeoutReader<H>

Create a new TimeoutReader with an optional timeout.

Examples

This first example creates the TimeoutReader with a 5-second timeout.

use timeout_readwrite::TimeoutReader;
use std::fs::File;
use std::time::Duration;

let mut f = File::open("file.txt")?;
let mut rdr = TimeoutReader::new(f, Duration::new(5, 0));

This example creates the TimeoutReader without a timeout at all.

use timeout_readwrite::TimeoutReader;
use std::fs::File;
use std::time::Duration;

let mut f = File::open("file.txt")?;
let mut rdr = TimeoutReader::new(f, None);

Trait Implementations

impl<H> Read for TimeoutReader<H> where
    H: Read + AsRawFd, 

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.

impl<H> Clone for TimeoutReader<H> where
    H: Read + AsRawFd + Clone, 

fn clone(&self) -> TimeoutReader<H>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.