embassy-time

Crates

git

Versions

default

Flavors

Struct Timer

Source
pub struct Timer { /* private fields */ }
Expand description

A future that completes at a specified Instant.

Implementations§

Source§

impl Timer

Source

pub fn at(expires_at: Instant) -> Self

Expire at specified Instant

Source

pub fn after(duration: Duration) -> Self

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

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;
}
Source

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().

Source

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().

Source

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().

Source

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().

Source

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§

Source§

impl Future for Timer

Source§

type Output = ()

The type of value produced on completion.
Source§

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. Read more
Source§

impl Unpin for Timer

Auto Trait Implementations§

§

impl Freeze for Timer

§

impl RefUnwindSafe for Timer

§

impl Send for Timer

§

impl Sync for Timer

§

impl UnwindSafe for Timer

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<F> WithTimeout for F
where F: Future,

Source§

type Output = <F as Future>::Output

Output type of the future.
Source§

fn with_timeout(self, timeout: Duration) -> TimeoutFuture<F>

Runs a given future with a timeout. Read more
Source§

fn with_deadline(self, at: Instant) -> TimeoutFuture<F>

Runs a given future with a deadline time. Read more