Struct tokio_io_timeout::TimeoutStream
[−]
[src]
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,
[src]
S: AsyncRead + AsyncWrite,
ⓘImportant traits for TimeoutStream<S>pub fn new(stream: S) -> TimeoutStream<S>
[src]
Returns a new TimeoutStream
wrapping the specified stream.
There is initially no read or write timeout.
pub fn read_timeout(&self) -> Option<Duration>
[src]
Returns the current read timeout.
pub fn set_read_timeout(&mut self, timeout: Option<Duration>)
[src]
Sets the read timeout.
This will reset any pending read timeout.
pub fn write_timeout(&self) -> Option<Duration>
[src]
Returns the current write timeout.
pub fn set_write_timeout(&mut self, timeout: Option<Duration>)
[src]
Sets the write timeout.
This will reset any pending write timeout.
pub fn get_ref(&self) -> &S
[src]
Returns a shared reference to the inner stream.
pub fn get_mut(&mut self) -> &mut S
[src]
Returns a mutable reference to the inner stream.
pub fn into_inner(self) -> S
[src]
Consumes the stream, returning the inner stream.
Trait Implementations
impl<S> Read for TimeoutStream<S> where
S: AsyncRead + AsyncWrite,
[src]
S: AsyncRead + AsyncWrite,
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, appending them to 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<S> AsyncRead for TimeoutStream<S> where
S: AsyncRead + AsyncWrite,
[src]
S: AsyncRead + AsyncWrite,
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 poll_read(&mut self, buf: &mut [u8]) -> Result<Async<usize>, Error>
[src]
Attempt to read from the AsyncRead
into buf
. 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<S> Write for TimeoutStream<S> where
S: AsyncRead + AsyncWrite,
[src]
S: AsyncRead + AsyncWrite,
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<S> AsyncWrite for TimeoutStream<S> where
S: AsyncRead + AsyncWrite,
[src]
S: AsyncRead + 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
fn poll_write(&mut self, buf: &[u8]) -> Result<Async<usize>, Error>
[src]
Attempt to write bytes from buf
into the object. Read more
fn poll_flush(&mut self) -> Result<Async<()>, Error>
[src]
Attempt to flush the object, ensuring that any buffered data reach their destination. Read more
Auto Trait Implementations
impl<S> Send for TimeoutStream<S> where
S: Send,
S: Send,
impl<S> Sync for TimeoutStream<S> where
S: Sync,
S: Sync,