Struct Time

pub struct Time<Ev> { /* private fields */ }

The Time capability API

This capability provides access to the current time and allows the app to ask for notifications when a specific instant has arrived or a duration has elapsed.

Implementations

impl<Ev> Time<Ev>

where Ev: 'static,

pub fn new(context: CapabilityContext<TimeRequest, Ev>) -> Self

pub fn now<F>(&self, callback: F)

where F: FnOnce(TimeResponse) -> Ev + Send + Sync + 'static,

Request current time, which will be passed to the app as a TimeResponse containing an Instant wrapped in the event produced by the callback.

pub async fn now_async(&self) -> TimeResponse

Request current time, which will be passed to the app as a TimeResponse containing an Instant This is an async call to use with [crux_core::compose::Compose].

pub fn notify_at<F>(&self, instant: Instant, callback: F) -> TimerId

where F: FnOnce(TimeResponse) -> Ev + Send + Sync + 'static,

Ask to receive a notification when the specified Instant has arrived.

pub fn notify_at_async( &self, instant: Instant, ) -> (TimerFuture<impl Future<Output = TimeResponse>>, TimerId)

Ask to receive a notification when the specified Instant has arrived. This is an async call to use with [crux_core::compose::Compose].

pub fn notify_after<F>(&self, duration: Duration, callback: F) -> TimerId

where F: FnOnce(TimeResponse) -> Ev + Send + Sync + 'static,

Ask to receive a notification when the specified duration has elapsed.

pub fn notify_after_async( &self, duration: Duration, ) -> (TimerFuture<impl Future<Output = TimeResponse>>, TimerId)

Ask to receive a notification when the specified duration has elapsed. This is an async call to use with [crux_core::compose::Compose].

pub fn clear(&self, id: TimerId)

Trait Implementations

impl<Ev> Capability<Ev> for Time<Ev>

type Operation = TimeRequest

type MappedSelf<MappedEv> = Time<MappedEv>

fn map_event<F, NewEv>(&self, f: F) -> Self::MappedSelf<NewEv>

where F: Fn(NewEv) -> Ev + Send + Sync + 'static, Ev: 'static, NewEv: 'static + Send,

impl<Ev> Clone for Time<Ev>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.