Struct tokio::time::Delay

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

This is supported on feature="time" only.

Future returned by delay_until and delay_for.

Methods

impl Delay

pub fn deadline(&self) -> Instant

This is supported on feature="time" only.

Returns the instant at which the future will complete.

pub fn is_elapsed(&self) -> bool

This is supported on feature="time" only.

Returns true if the Delay has elapsed

A Delay is elapsed when the requested duration has elapsed.

pub fn reset(&mut self, deadline: Instant)

This is supported on feature="time" only.

Reset the Delay instance to a new deadline.

Calling this function allows changing the instant at which the Delay future completes without having to create new associated state.

This function can be called both before and after the future has completed.

Trait Implementations

impl Debug for Delay

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

Formats the value using the given formatter.

impl Future for Delay

type Output = ()

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.