Struct tokio_timer_futures2::Timeout

#[must_use = "futures do nothing unless polled"]
pub struct Timeout<T> { /* fields omitted */ }

Allows a given Future to execute for a max duration

Methods

impl<T> Timeout<T>

pub fn get_ref(&self) -> &T

Gets a reference to the underlying future in this timeout.

Panics

This function panics if the underlying future has already been consumed.

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

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

Panics

This function panics if the underlying future has already been consumed.

pub fn into_inner(self) -> T

Consumes this timeout, returning the underlying future.

Panics

This function panics if the underlying future has already been consumed.

Trait Implementations

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

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<F, E> Future for Timeout<F> where
    F: Future<Error = E>,
    E: From<TimeoutError<F>>, 

type Item = F::Item

A successful value

type Error = E

An error

fn poll(&mut self, cx: &mut Context) -> Poll<F::Item, E>

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