Struct Timer 

pub struct Timer { /* private fields */ }

A future that completes at a specified Instant.

Implementations

impl Timer

pub fn at(expires_at: Instant) -> Self

Expire at specified Instant Will expire immediately if the Instant is in the past.

pub fn after(duration: impl Into<Duration>) -> Self

Expire after specified Duration. This can be used as a sleep abstraction.

Note: You must ensure that Instant::now() when added to the intended sleep duration does not overflow the u64 tick counter or a panic will occur.

For example Timer::after(Duration::MAX) will always panic and must be avoided.

The same restriction applies to with_timeout() and the other after_* functions.

Example:

use embassy_time::{Duration, Timer};

#[embassy_executor::task]
async fn demo_sleep_seconds() {
    // suspend this task for one second.
    Timer::after(Duration::from_secs(1)).await;
}

pub fn after_ticks(ticks: u64) -> Self

Expire after the specified number of ticks.

This method is a convenience wrapper for calling Timer::after(Duration::from_ticks()). For more details, refer to Timer::after() and Duration::from_ticks().

pub fn after_nanos(nanos: u64) -> Self

Expire after the specified number of nanoseconds.

This method is a convenience wrapper for calling Timer::after(Duration::from_nanos()). For more details, refer to Timer::after() and Duration::from_nanos().

pub fn after_micros(micros: u64) -> Self

Expire after the specified number of microseconds.

This method is a convenience wrapper for calling Timer::after(Duration::from_micros()). For more details, refer to Timer::after() and Duration::from_micros().

pub fn after_millis(millis: u64) -> Self

Expire after the specified number of milliseconds.

This method is a convenience wrapper for calling Timer::after(Duration::from_millis()). For more details, refer to Timer::after and Duration::from_millis().

pub fn after_secs(secs: u64) -> Self

Expire after the specified number of seconds.

This method is a convenience wrapper for calling Timer::after(Duration::from_secs()). For more details, refer to Timer::after and Duration::from_secs().

Trait Implementations

impl Debug for Timer

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

Formats the value using the given formatter.

impl Format for Timer

where Instant: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl Future for Timer

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.

impl Unpin for Timer