Struct TaskSchedule 

pub struct TaskSchedule<R: SleepProvider> { /* private fields */ }

A remotely-controllable trigger for recurring tasks.

This implements Stream, and is intended to be used in a while loop; you should wrap your recurring task in a while schedule.next().await.is_some() or similar.

Implementations

impl<R: SleepProvider> TaskSchedule<R>

pub fn new(rt: R) -> (Self, TaskHandle)

Create a new schedule, and corresponding handle.

pub fn fire_in(&mut self, dur: Duration)

Trigger the schedule after dur.

pub fn fire(&mut self)

Trigger the schedule instantly.

pub async fn sleep(&mut self, dur: Duration) -> Result<(), SleepError>

Wait until Dur has elapsed.

This call is equivalent to SleepProvider::sleep, except that the resulting future will respect calls to the functions on this schedule’s associated TaskHandle.

Alternatively, you can view this function as equivalent to self.fire_in(dur); self.next().await;, only with the intent made more explicit.

If the associated TaskHandle for this schedule is suspended, then this method will not return until the schedule is unsuspended and the timer elapses. If the associated TaskHandle is cancelled, then this method will not return at all, until the schedule is re-activated by TaskHandle::fire or TaskHandle::fire_at.

Finally, if every associated TaskHandle has been dropped, then this method will return an error.

pub async fn sleep_until_wallclock( &mut self, when: SystemTime, ) -> Result<(), SleepError>

As sleep_until_wallclock, but respect messages from this schedule’s associated TaskHandle.

Trait Implementations

impl<R: SleepProvider> Stream for TaskSchedule<R>

type Item = ()

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, R: SleepProvider> Unpin for TaskSchedule<R>

where PinnedFieldsOf<__TaskSchedule<'pin, R>>: Unpin,

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.