Struct Timeout

pub struct Timeout<'timer, F> { /* private fields */ }

A Future that requires an inner Future to complete within a specified Duration.

This Future is returned by the timeout and try_timeout functions, and by the Timer::timeout and Timer::try_timeout methods.

Output

• Ok(F::Output) if the inner future completed before the specified timeout.
• Err(Elapsed) if the timeout elapsed before the inner Future completed.

Cancellation

Dropping a Timeout future cancels the timeout. The wrapped Future can be extracted from the Timeout future by calling Timeout::into_inner, allowing the future to be polled without failing if the timeout elapses.

Implementations

impl<'timer, F: Future> Timeout<'timer, F>

pub fn into_inner(self) -> F

Consumes this Timeout, returning the inner Future.

This can be used to continue polling the inner Future without requiring it to complete prior to the specified timeout.

pub fn get_ref(&self) -> &F

Borrows the inner Future immutably.

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

Mutably the inner Future.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut F>

Borrows the inner Future as a Pinned reference, if this Timeout is pinned.

pub fn duration(&self) -> Duration

Returns the Duration the inner Future is allowed to run for.

Trait Implementations

impl<'timer, F: Debug> Debug for Timeout<'timer, F>

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

Formats the value using the given formatter.

impl<F: Future> Future for Timeout<'_, F>

type Output = Result<<F as Future>::Output, Elapsed>

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<'pin, 'timer, F> Unpin for Timeout<'timer, F>

where PinnedFieldsOf<__Timeout<'pin, 'timer, F>>: Unpin,