Struct tokio_io_timeout::TimeoutStream

pub struct TimeoutStream<S>(_);

A stream which applies read and write timeouts to an inner stream.

Methods

impl<S> TimeoutStream<S> where
    S: AsyncRead + AsyncWrite + Unpin, 

pub fn new(stream: S) -> TimeoutStream<S>

Returns a new TimeoutStream wrapping the specified stream.

There is initially no read or write timeout.

pub fn read_timeout(&self) -> Option<Duration>

Returns the current read timeout.

pub fn set_read_timeout(&mut self, timeout: Option<Duration>)

Sets the read timeout.

This will reset any pending read timeout.

pub fn write_timeout(&self) -> Option<Duration>

Returns the current write timeout.

pub fn set_write_timeout(&mut self, timeout: Option<Duration>)

Sets the write timeout.

This will reset any pending write timeout.

pub fn get_ref(&self) -> &S

Returns a shared reference to the inner stream.

pub fn get_mut(&mut self) -> &mut S

Returns a mutable reference to the inner stream.

pub fn into_inner(self) -> S

Consumes the stream, returning the inner stream.

Trait Implementations

impl<S: Debug> Debug for TimeoutStream<S>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<S> AsyncRead for TimeoutStream<S> where
    S: AsyncRead + AsyncWrite + Unpin, 

unsafe fn prepare_uninitialized_buffer(&self, buf: &mut [u8]) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_buf<B>(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut B
) -> Poll<Result<usize, Error>> where
    B: BufMut, 

Pull some bytes from this source into the specified BufMut, returning how many bytes were read.

impl<S> AsyncWrite for TimeoutStream<S> where
    S: AsyncRead + AsyncWrite + Unpin, 

fn poll_write(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_buf<B>(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut B
) -> Poll<Result<usize, Error>> where
    B: Buf, 

Write a Buf into this value, returning how many bytes were written.