Struct Deadline

pub struct Deadline { /* private fields */ }

Future returned by deadline.

Examples

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

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

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

Implementations

impl Deadline

pub fn new(duration: Millis) -> Deadline

Create new deadline future

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

Resets the Deadline instance to a new deadline.

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

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

pub fn is_elapsed(&self) -> bool

Returns true if Deadline has elapsed.

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

Trait Implementations

impl Debug for Deadline

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

Formats the value using the given formatter.

impl Future for Deadline

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.