Struct TimeoutWriter

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

The TimeoutWriter struct adds write timeouts to any writer.

The write call on a Write instance can block forever until data cannot be written. A TimeoutWriter will wait until data can be written, up until an optional timeout, before actually performing the write operation on the underlying writer.

If any Write 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 Write trait could also be produced by the TimeoutWriter.

Implementations

impl<H> TimeoutWriter<H>

where H: Write + AsFd,

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

Create a new TimeoutWriter with an optional timeout.

Examples

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

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

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

This example creates the TimeoutWriter without a timeout at all.

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

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

Trait Implementations

impl<H> AsFd for TimeoutWriter<H>

where H: Write + AsFd,

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

Borrows the file descriptor.

impl<H> Clone for TimeoutWriter<H>

where H: Write + AsFd + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H> Seek for TimeoutWriter<H>

where H: Write + 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.

impl<H> Write for TimeoutWriter<H>

where H: Write + AsFd,

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

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.