TimerApi

Struct TimerApi 

Source
pub struct TimerApi;
Expand description

TimerApi Lifecycle timer api façade for macro-expanded entrypoints.

Implementations§

Source§

impl TimerApi

Source

pub fn set_lifecycle_timer( delay: Duration, label: impl Into<String>, task: impl Future<Output = ()> + 'static, ) -> TimerHandle

Public, stable surface for macro-expanded code in downstream crates. Performs no logic; delegates to internal TimerOps.

Source

pub fn set_guarded( slot: &'static TimerSlot, delay: Duration, label: impl Into<String>, task: impl Future<Output = ()> + 'static, ) -> bool

Schedule a one-shot timer only if the slot is empty. Returns true when a new timer was scheduled.

Source

pub fn set_interval<F, Fut>( interval: Duration, label: impl Into<String>, task: F, ) -> TimerHandle
where F: FnMut() -> Fut + 'static, Fut: Future<Output = ()> + 'static,

Schedule a repeating timer. Task produces a fresh Future on each tick.

Source

pub fn set_guarded_interval<FInit, InitFut, FTick, TickFut>( slot: &'static TimerSlot, init_delay: Duration, init_label: impl Into<String>, init_task: FInit, interval: Duration, interval_label: impl Into<String>, tick_task: FTick, ) -> bool
where FInit: FnOnce() -> InitFut + 'static, InitFut: Future<Output = ()> + 'static, FTick: FnMut() -> TickFut + 'static, TickFut: Future<Output = ()> + 'static,

Schedule a guarded init timer that installs a repeating interval timer.

Source

pub fn clear_lifecycle_timer(handle: TimerHandle)

Optional cancellation.

Auto Trait Implementations§

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<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V