Struct job_scheduler::JobScheduler

pub struct JobScheduler<'a> { /* fields omitted */ }

The JobScheduler contains and executes the scheduled jobs.

Methods

impl<'a> JobScheduler<'a>

pub fn new() -> JobScheduler<'a>

Create a new JobScheduler.

pub fn add(&mut self, job: Job<'a>) -> Uuid

Add a job to the JobScheduler

let mut sched = JobScheduler::new();
sched.add(Job::new("1/10 * * * * *".parse().unwrap(), || {
    println!("I get executed every 10 seconds!");
}));

pub fn remove(&mut self, job_id: Uuid) -> bool

Remove a job from the JobScheduler

let mut sched = JobScheduler::new();
let job_id = sched.add(Job::new("1/10 * * * * *".parse().unwrap(), || {
    println!("I get executed every 10 seconds!");
}));
sched.remove(job_id);

pub fn tick(&mut self)

The tick method increments time for the JobScheduler and executes any pending jobs. It is recommended to sleep for at least 500 milliseconds between invocations of this method.

loop {
    sched.tick();
    std::thread::sleep(Duration::from_millis(500));
}

pub fn time_till_next_job(&self) -> Duration

The time_till_next_job method returns the duration till the next job is supposed to run. This can be used to sleep until then without waking up at a fixed interval.AsMut

loop {
    sched.tick();
    std::thread::sleep(sched.time_till_next_job());
}

Trait Implementations

impl<'a> Default for JobScheduler<'a>

fn default() -> JobScheduler<'a>

Returns the "default value" for a type.