Struct tokio::time::Sleep

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

This is supported on crate feature time only.

Future returned by sleep and sleep_until.

Implementations

impl Sleep

pub fn deadline(&self) -> Instant

Returns the instant at which the future will complete.

pub fn is_elapsed(&self) -> bool

Returns true if Sleep has elapsed.

A Sleep instance is elapsed when the requested duration has elapsed.

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

Resets the Sleep instance to a new deadline.

Calling this function allows changing the instant at which the Sleep 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 Sleep

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

Formats the value using the given formatter.

impl Drop for Sleep

fn drop(&mut self)

Executes the destructor for this type.

impl Future for Sleep

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.