Struct tokio_io_timeout::TimeoutReader
[−]
[src]
pub struct TimeoutReader<R> { /* fields omitted */ }
An AsyncRead
er which applies a timeout to read operations.
Methods
impl<R> TimeoutReader<R> where
R: AsyncRead,
[src]
R: AsyncRead,
fn new(reader: R, handle: &Handle) -> Result<TimeoutReader<R>>
[src]
Returns a new TimeoutReader
wrapping the specified reader.
There is initially no timeout.
fn timeout(&self) -> Option<Duration>
[src]
Returns the current read timeout.
fn set_timeout(&mut self, timeout: Option<Duration>)
[src]
Sets the read timeout.
This will reset any pending timeout.
fn get_ref(&self) -> &R
[src]
Returns a shared reference to the inner reader.
fn get_mut(&mut self) -> &mut R
[src]
Returns a mutable reference to the inner reader.
fn into_inner(self) -> R
[src]
Consumes the TimeoutReader
, returning the inner reader.
Trait Implementations
impl<R> Read for TimeoutReader<R> where
R: AsyncRead,
[src]
R: AsyncRead,
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
unsafe fn initializer(&self) -> Initializer
[src]
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
fn chars(self) -> Chars<Self>
[src]
🔬 This is a nightly-only experimental API. (io
)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an [Iterator
] over [char
]s. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
Creates an adaptor which will read at most limit
bytes from it. Read more
impl<R> AsyncRead for TimeoutReader<R> where
R: AsyncRead,
[src]
R: AsyncRead,
unsafe fn prepare_uninitialized_buffer(&self, buf: &mut [u8]) -> bool
[src]
Prepares an uninitialized buffer to be safe to pass to read
. Returns true
if the supplied buffer was zeroed out. Read more
fn read_buf<B: BufMut>(&mut self, buf: &mut B) -> Poll<usize, Error>
[src]
Pull some bytes from this source into the specified Buf
, returning how many bytes were read. Read more
fn framed<T>(self, codec: T) -> Framed<Self, T> where
Self: AsyncWrite,
T: Decoder + Encoder,
[src]
Self: AsyncWrite,
T: Decoder + Encoder,
Provides a Stream
and Sink
interface for reading and writing to this Io
object, using Decode
and Encode
to read and write the raw data. Read more
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
[src]
Self: AsyncWrite,
Helper method for splitting this read/write object into two halves. Read more
impl<R> Write for TimeoutReader<R> where
R: Write,
[src]
R: Write,
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[src]
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Write
. Read more
impl<R> AsyncWrite for TimeoutReader<R> where
R: AsyncWrite,
[src]
R: AsyncWrite,
fn shutdown(&mut self) -> Poll<(), Error>
[src]
Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down. Read more
fn write_buf<B: Buf>(&mut self, buf: &mut B) -> Poll<usize, Error>
[src]
Write a Buf
into this value, returning how many bytes were written. Read more