Struct timeout_readwrite::reader::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.

If any Read operation times out, the method called will return an io::ErrorKind::TimedOut variant as the value of io::Error. All other error values that would normally be produced by the underlying implementation of the Read trait could also be produced by the TimeoutReader.

Methods

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

Important traits for TimeoutReader<H>

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

pub 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> Clone for TimeoutReader<H> where
    H: Read + AsRawFd + Clone, 

Important traits for TimeoutReader<H>

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Seek to an offset, in bytes, in a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬 This is a nightly-only experimental API. (seek_convenience)

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

🔬 This is a nightly-only experimental API. (seek_convenience)

Returns the current seek position from the start of the stream.

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.

fn read_vectored(&mut self, bufs: &mut [IoVecMut]) -> Result<usize, Error>

🔬 This is a nightly-only experimental API. (iovec)

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.

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

fn as_raw_fd(&self) -> c_int

Extracts the raw file descriptor.