Struct Timeout 

pub struct Timeout<T> { /* private fields */ }

Implementations

impl<T> Timeout<T>

pub fn new(inner: T, duration: Duration) -> Self

Create a timeout for Stream or Future.

pub fn from_stream(inner: T, duration: Duration) -> Self

where T: Stream,

Create a timeout from a stream

pub fn from_future(inner: T, duration: Duration) -> Self

where T: Future,

Create a timeout from a future

pub fn into_inner(self) -> T

Consumes Timeout and returns the inner value

Trait Implementations

impl<T: Debug> Debug for Timeout<T>

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

Formats the value using the given formatter.

impl<T> Deref for Timeout<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Timeout<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Future> FusedFuture for Timeout<T>

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

impl<T: Stream> FusedStream for Timeout<T>

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<T: Future> Future for Timeout<T>

type Output = Result<<T as Future>::Output, TimeoutError>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<T: Stream> Stream for Timeout<T>

type Item = Result<<T as Stream>::Item, TimeoutError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, T> Unpin for Timeout<T>

where PinnedFieldsOf<__Timeout<'pin, T>>: Unpin,