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

Methods

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

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

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

Write a buffer into this object, 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_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.