Struct timer_kit::Sleep

pub struct Sleep<D: Delay> { /* private fields */ }

A future that completes after a specified duration.

This future calls Delay::poll_elapsed internally.

Type Parameter

• D: The underlying timer type that implements the Delay trait

Implementations

impl<D> Sleep<D>where
    D: Delay,

pub fn new(duration: Duration) -> Self

Creates a new Sleep that completes after the specified duration.

Example

Creates a sleep with smol’s timer

use std::time::Duration;
use timer_kit::Sleep;
 
let sleep = Sleep::<smol::Timer>::new(Duration::from_millis(100));
sleep.await;

Creates a sleep with fluvio_wasm_timer::Delay

use std::time::Duration;
use timer_kit::Sleep;
 
let sleep = Sleep::<fluvio_wasm_timer::Delay>::new(Duration::from_millis(100));
sleep.await;

pub fn new_until(deadline: D::Instant) -> Self

Creates a new Sleep that completes at the specified deadline

Example

Creates a sleep with smol’s timer

use std::time::{Duration, Instant};
use timer_kit::Sleep;
 
let sleep = Sleep::<smol::Timer>::new_until(Instant::now() + Duration::from_millis(100));
sleep.await;

Creates a sleep with fluvio_wasm_timer::Delay

use std::time::{Duration};
use fluent_wasm_timer::Instant;
use timer_kit::Sleep;
 
let sleep = Sleep::<fluvio_wasm_timer::Delay>::new_until(Instant::now() + Duration::from_millis(100));
sleep.await;

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

Reset the Sleep to a new deadline

pub fn deadline(&self) -> D::Instant

Gets the deadline

Trait Implementations

impl<D: Debug + Delay> Debug for Sleep<D>where
    D::Instant: Debug,

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

Formats the value using the given formatter.

impl<D> Future for Sleep<D>where
    D: Delay,
    D::Instant: Unpin,

type Output = <D as Delay>::Value

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.