Struct TimeoutReader

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

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.

Implementations

impl<H> TimeoutReader<H>

where H: Read + AsFd,

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> AsFd for TimeoutReader<H>

where H: Read + AsFd,

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl<H> Clone for TimeoutReader<H>

where H: Read + AsFd + Clone,

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> Read for TimeoutReader<H>

where H: Read + AsFd,

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 [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

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

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<H> Seek for TimeoutReader<H>

where H: Read + AsFd + Seek,

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

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

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

Rewind to the beginning of a stream.

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

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

Returns the length of this stream (in bytes).

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

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

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.