Struct tokio_io_timeout::TimeoutReader

pub struct TimeoutReader<R> { /* fields omitted */ }

An AsyncReader which applies a timeout to read operations.

Implementations

impl<R> TimeoutReader<R> where
    R: AsyncRead, 

pub fn new(reader: R) -> TimeoutReader<R>

Returns a new TimeoutReader wrapping the specified reader.

There is initially no timeout.

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

Returns the current read timeout.

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

Sets the read timeout.

This will reset any pending timeout.

pub fn get_ref(&self) -> &R

Returns a shared reference to the inner reader.

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

Returns a mutable reference to the inner reader.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut R>

Returns a pinned mutable reference to the inner reader.

pub fn into_inner(self) -> R

Consumes the TimeoutReader, returning the inner reader.

Trait Implementations

impl<R> AsyncRead for TimeoutReader<R> where
    R: AsyncRead, 

pub fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut ReadBuf<'_>
) -> Poll<Result<(), Error>>

Attempts to read from the AsyncRead into buf.

impl<R> AsyncWrite for TimeoutReader<R> where
    R: AsyncWrite, 

pub 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.

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

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

pub 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.

pub fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

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

pub fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<R: Debug> Debug for TimeoutReader<R>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'pin, R> Unpin for TimeoutReader<R> where
    __TimeoutReader<'pin, R>: Unpin,