Struct ndless_async::timer::TimerListener

pub struct TimerListener { /* fields omitted */ }

Timer Listener

Used to create Timers, which may be .awaited to wait for a specific time. See AsyncListeners to get one.

Implementations

impl TimerListener

pub fn sleep_ms(&self, ms: u32) -> Timer

Sleeps for the specified number of milliseconds. Problems will occur when sleeping for more than 2^31/32768 seconds, which is about 18 hours.

pub fn sleep(&self, dur: Duration) -> Timer

Sleeps for the specified Duration. Problems will occur when sleeping for more than 2^31/32768 seconds, which is about 18 hours.

This function has a resolution of 30 μs.

pub fn sleep_ticks(&self, ticks: u32) -> Timer

Sleeps for the specified number of ticks. Problems will occur when sleeping for more than 2^31 ticks, which is about 18 hours.

pub fn sleep_until(&self, ticks: u32) -> Timer

Sleeps until the current number of ticks is equal to the parameter. Problems will occur when sleeping for more than 2^31 ticks in the future, which is about 18 hours.

pub async fn timeout_ms<'_, T>(
    &'_ self,
    ms: u32,
    f: impl Future<Output = T>
) -> Result<T, TimeoutError>

Awaits a future or times out after the specified number of milliseconds. Problems will occur when sleeping for more than 2^31/32768 seconds, which is about 18 hours.

pub async fn timeout<'_, T>(
    &'_ self,
    dur: Duration,
    f: impl Future<Output = T>
) -> Result<T, TimeoutError>

Awaits a future or times out after the specified Duration. Problems will occur when sleeping for more than 2^31/32768 seconds, which is about 18 hours.

This function has a resolution of 30 μs.

pub async fn timeout_ticks<'_, T>(
    &'_ self,
    ticks: u32,
    f: impl Future<Output = T>
) -> Result<T, TimeoutError>

Awaits a future or times out after the specified number of ticks. Problems will occur when sleeping for more than 2^31 ticks, which is about 18 hours.

pub async fn timeout_until<'_, T>(
    &'_ self,
    ticks: u32,
    f: impl Future<Output = T>
) -> Result<T, TimeoutError>

Awaits a future or times out after the current number of ticks is equal to the parameter. Problems will occur when sleeping for more than 2^31 ticks in the future, which is about 18 hours.

pub fn every_hz(&self, hz: u32) -> Interval

Creates a Stream that triggers with the specified number of events per second.

pub fn every_ms(&self, ms: u32) -> Interval

Creates a Stream that triggers every specified number of milliseconds. Problems will occur when sleeping for more than 2^31/32768 seconds, which is about 18 hours.

pub fn every(&self, dur: Duration) -> Interval

Creates a Stream that triggers every specified Duration. Problems will occur when sleeping for more than 2^31/32768 seconds, which is about 18 hours.

This function has a resolution of 30 μs.

pub fn every_ticks(&self, ticks: u32) -> Interval

Creates a Stream that triggers every specified number of ticks. Problems will occur when sleeping for more than 2^31 ticks, which is about 18 hours.

Trait Implementations

impl Default for TimerListener

fn default() -> TimerListener

Returns the "default value" for a type.