Struct ScheduledTaskManager 

pub struct ScheduledTaskManager { /* private fields */ }

Implementations

impl ScheduledTaskManager

pub fn new() -> Self

pub fn add_fixed_rate_task<F, Fut>( &self, initial_delay: Duration, period: Duration, task_fn: F, ) -> u64

where F: FnMut(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Adds a fixed-rate scheduled task to the task manager.

Arguments

• initial_delay - The delay before the first execution of the task.
• period - The interval between task executions.
• task_fn - A function that defines the task to be executed. It takes a CancellationToken as an argument and returns a Future that resolves to a Result<()>.

Returns

A TaskId representing the unique identifier of the scheduled task.

Notes

• Tasks are executed at fixed intervals, even if previous executions overlap.

pub fn add_fixed_delay_task<F, Fut>( &self, initial_delay: Duration, period: Duration, task_fn: F, ) -> u64

where F: FnMut(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Adds a fixed-delay scheduled task to the task manager.

Arguments

• initial_delay - The delay before the first execution of the task.
• period - The interval between task executions.
• task_fn - A function that defines the task to be executed. It takes a CancellationToken as an argument and returns a Future that resolves to a Result<()>.

Returns

A TaskId representing the unique identifier of the scheduled task.

Notes

• Tasks are executed serially, with a delay after each task completes.

pub fn add_fixed_rate_no_overlap_task<F, Fut>( &self, initial_delay: Duration, period: Duration, task_fn: F, ) -> u64

where F: FnMut(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Adds a fixed-rate-no-overlap scheduled task to the task manager.

Arguments

• initial_delay - The delay before the first execution of the task.
• period - The interval between task executions.
• task_fn - A function that defines the task to be executed. It takes a CancellationToken as an argument and returns a Future that resolves to a Result<()>.

Returns

A TaskId representing the unique identifier of the scheduled task.

Notes

• Tasks are executed at fixed intervals, but overlapping executions are skipped.

pub fn add_scheduled_task<F, Fut>( &self, mode: ScheduleMode, initial_delay: Duration, period: Duration, task_fn: F, ) -> u64

where F: FnMut(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Adds a scheduled task to the task manager.

Arguments

• mode - The scheduling mode for the task. Determines how the task is executed:
  • FixedRate: Aligns the beats, allowing tasks to pile up if they take too long.
  • FixedDelay: Executes tasks serially, with a delay after each task completes.
  • FixedRateNoOverlap: Aligns the beats but skips execution if the previous task is still running.
• initial_delay - The delay before the first execution of the task.
• period - The interval between task executions.
• task_fn - A function that defines the task to be executed. It takes a CancellationToken as an argument and returns a Future that resolves to a Result<()>.

Returns

A TaskId representing the unique identifier of the scheduled task.

Notes

• The task function is executed asynchronously.
• The CancellationToken can be used to gracefully cancel the task.
• The task is added to the internal task manager and can be managed (e.g., canceled or aborted) later.

pub fn cancel_task(&self, id: u64)

Graceful cancellation

pub fn abort_task(&self, id: u64)

Roughly abort

pub fn cancel_all(&self)

Batch cancel

pub fn abort_all(&self)

Batch abort

pub fn task_count(&self) -> usize

impl ScheduledTaskManager

pub fn add_fixed_rate_task_async<F>( &self, initial_delay: Duration, period: Duration, task_fn: F, ) -> u64

where F: AsyncFnMut(CancellationToken) -> Result<()> + Send + Sync + 'static, for<'a> <F as AsyncFnMut<(CancellationToken,)>>::CallRefFuture<'a>: Send,

Adds a fixed-rate scheduled task to the task manager asynchronously.

Arguments

• initial_delay - The delay before the first execution of the task.
• period - The interval between task executions.
• task_fn - A function that defines the task to be executed. It takes a CancellationToken as an argument and returns a Result<()>.

Returns

A TaskId representing the unique identifier of the scheduled task.

Notes

• Tasks are executed at fixed intervals, even if previous executions overlap.
• The task function is executed asynchronously.

pub fn add_fixed_delay_task_async<F>( &self, initial_delay: Duration, period: Duration, task_fn: F, ) -> u64

where F: AsyncFnMut(CancellationToken) -> Result<()> + Send + Sync + 'static, for<'a> <F as AsyncFnMut<(CancellationToken,)>>::CallRefFuture<'a>: Send,

Adds a fixed-delay scheduled task to the task manager asynchronously.

Arguments

• initial_delay - The delay before the first execution of the task.
• period - The interval between task executions.
• task_fn - A function that defines the task to be executed. It takes a CancellationToken as an argument and returns a Result<()>.

Returns

A TaskId representing the unique identifier of the scheduled task.

Notes

• Tasks are executed serially, with a delay after each task completes.
• The task function is executed asynchronously.

pub fn add_fixed_rate_no_overlap_task_async<F>( &self, initial_delay: Duration, period: Duration, task_fn: F, ) -> u64

where F: AsyncFnMut(CancellationToken) -> Result<()> + Send + Sync + 'static, for<'a> <F as AsyncFnMut<(CancellationToken,)>>::CallRefFuture<'a>: Send,

Adds a fixed-rate-no-overlap scheduled task to the task manager asynchronously.

Arguments

• initial_delay - The delay before the first execution of the task.
• period - The interval between task executions.
• task_fn - A function that defines the task to be executed. It takes a CancellationToken as an argument and returns a Result<()>.

Returns

A TaskId representing the unique identifier of the scheduled task.

Notes

• Tasks are executed at fixed intervals, but overlapping executions are skipped.
• The task function is executed asynchronously.

pub fn add_scheduled_task_async<F>( &self, mode: ScheduleMode, initial_delay: Duration, period: Duration, task_fn: F, ) -> u64

where F: AsyncFnMut(CancellationToken) -> Result<()> + Send + Sync + 'static, for<'a> <F as AsyncFnMut<(CancellationToken,)>>::CallRefFuture<'a>: Send,

Adds a scheduled task to the task manager asynchronously.

Arguments

• mode - The scheduling mode for the task. Determines how the task is executed:
  • FixedRate: Aligns the beats, allowing tasks to pile up if they take too long.
  • FixedDelay: Executes tasks serially, with a delay after each task completes.
  • FixedRateNoOverlap: Aligns the beats but skips execution if the previous task is still running.
• initial_delay - The delay before the first execution of the task.
• period - The interval between task executions.
• task_fn - A function that defines the task to be executed. It takes a CancellationToken as an argument and returns a Future that resolves to a Result<()>.

Returns

A TaskId representing the unique identifier of the scheduled task.

Notes

• The task function is executed asynchronously.
• The CancellationToken can be used to gracefully cancel the task.
• The task is added to the internal task manager and can be managed (e.g., canceled or aborted) later.

Trait Implementations

impl Clone for ScheduledTaskManager

fn clone(&self) -> ScheduledTaskManager

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ScheduledTaskManager

fn default() -> Self

Returns the “default value” for a type.