Struct Scheduler 

pub struct Scheduler { /* private fields */ }

Async job scheduler with interval, one-shot, and cron-style scheduling.

Create a Scheduler, register jobs with Scheduler::schedule, then call Scheduler::start to launch the background run loop.

Implementations

impl Scheduler

pub fn new() -> Self

Create a new, empty scheduler.

pub async fn schedule<F>( &self, name: &str, schedule: Schedule, handler: F, ) -> JobId

where F: Fn() -> BoxFuture<'static, ()> + Send + Sync + 'static,

Register a new job and return its JobId.

handler is called every time the schedule fires. It must return a BoxFuture<'static, ()>.

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

Cancel a job by ID. Returns true if the job existed.

pub async fn enable(&self, id: JobId, enabled: bool)

Enable or disable a job. Disabled jobs are skipped by the run loop.

pub async fn stats(&self) -> Vec<JobStats>

Return a snapshot of stats for all registered jobs.

pub async fn run_loop(&self)

Background run loop. Checks all jobs every 100 ms and fires any whose next_tick has arrived. Each handler is spawned in its own Tokio task.

pub fn start(&self) -> JoinHandle<()>

Spawn the run loop as a background Tokio task and return its handle.

Trait Implementations

impl Clone for Scheduler

fn clone(&self) -> Scheduler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Scheduler

fn default() -> Self

Returns the “default value” for a type.