Struct tokio::time::Timeout

#[must_use = "futures do nothing unless you `.await` or poll them"]pub struct Timeout<T> { /* fields omitted */ }

This is supported on feature="time" only.

Future returned by timeout and timeout_at.

Implementations

impl<T> Timeout<T>

pub fn get_ref(&self) -> &Tⓘ

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

This is supported on feature="time" only.

Gets a reference to the underlying value in this timeout.

pub fn get_mut(&mut self) -> &mut Tⓘ

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

This is supported on feature="time" only.

Gets a mutable reference to the underlying value in this timeout.

pub fn into_inner(self) -> T

This is supported on feature="time" only.

Consumes this timeout, returning the underlying 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> Future for Timeout<T> where
    T: Future, 

type Output = Result<T::Output, Elapsed>

The type of value produced on completion.

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

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

impl<'__pin, T> Unpin for Timeout<T> where
    __Origin<'__pin, T>: Unpin,