Struct Sleep

pub struct Sleep { /* private fields */ }

Future returned by sleep.

Examples

Wait 100ms and print “100 ms have elapsed”.

use ntex::time::{sleep, Millis};

#[ntex::main]
async fn main() {
    sleep(Millis(100)).await;
    println!("100 ms have elapsed");
}

Implementations

impl Sleep

pub fn new(duration: Millis) -> Sleep

Create new sleep future

pub fn is_elapsed(&self) -> bool

Returns true if Sleep has elapsed.

pub fn reset<T: Into<Millis>>(&self, millis: T)

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.

pub fn poll_elapsed(&self, cx: &mut Context<'_>) -> Poll<()>

Trait Implementations

impl Debug for Sleep

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

Formats the value using the given formatter.

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>

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