Struct TaskScheduler 

pub struct TaskScheduler { /* private fields */ }

A scheduler for one-shot and periodic background tasks.

All tasks are cancelled when TaskScheduler::shutdown is called or when the scheduler is dropped.

Implementations

impl TaskScheduler

pub fn new() -> Self

Create a new task scheduler.

pub fn schedule_once<F, Fut>( &self, delay: Duration, label: impl Into<String>, f: F, ) -> TaskId

where F: FnOnce() -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Schedule a one-shot task that executes after delay.

Returns a TaskId that can be used to cancel the task.

pub fn schedule_periodic<F, Fut>( &self, interval: Duration, label: impl Into<String>, f: F, ) -> TaskId

where F: Fn(u64) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Schedule a periodic task that runs every interval.

The task function receives the current tick count (starting at 1). The first execution happens after interval elapses.

Returns a TaskId that can be used to cancel the task.

pub async fn cancel(&self, id: TaskId) -> bool

Cancel a previously scheduled task.

Returns true if the task was found and cancelled.

pub async fn active_count(&self) -> usize

Return the number of active (not yet completed / cancelled) tasks.

pub async fn shutdown(&self)

Cancel all tasks and shut down the scheduler.

Trait Implementations

impl Clone for TaskScheduler

fn clone(&self) -> TaskScheduler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaskScheduler

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

Formats the value using the given formatter.

impl Default for TaskScheduler

fn default() -> Self

Returns the “default value” for a type.