Struct timeout_readwrite::writer::TimeoutWriter

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

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.

Methods

impl<H> TimeoutWriter<H> where
    H: Write + AsRawFd, 

Important traits for TimeoutWriter<H>

impl<H> Write for TimeoutWriter<H> where
    H: Write + AsRawFd, 

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> Clone for TimeoutWriter<H> where
    H: Write + AsRawFd + Clone, 

Important traits for TimeoutWriter<H>

impl<H> Write for TimeoutWriter<H> where
    H: Write + AsRawFd, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H> Seek for TimeoutWriter<H> where
    H: Write + 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> Write for TimeoutWriter<H> where
    H: Write + AsRawFd, 

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

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

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

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

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

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

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

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

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

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

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

Creates a "by reference" adaptor for this instance of Write.

impl<H> AsRawFd for TimeoutWriter<H> where
    H: Write + AsRawFd, 

fn as_raw_fd(&self) -> c_int

Extracts the raw file descriptor.