Struct edm_core::schedule::AsyncJobScheduler

pub struct AsyncJobScheduler { /* private fields */ }

A type contains and executes the async scheduled jobs.

Implementations

impl AsyncJobScheduler

pub fn new() -> Self

Creates a new instance.

pub fn add(&mut self, job: AsyncJob) -> Uuid

Adds an async job to the scheduler and returns the job ID.

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

Removes an async job by ID from the scheduler.

pub fn get(&self, job_id: Uuid) -> Option<&AsyncJob>

Returns a reference to the job with the ID.

pub fn get_mut(&mut self, job_id: Uuid) -> Option<&mut AsyncJob>

Returns a mutable reference to the job with the ID.

pub fn time_till_next_job(&self) -> Duration

Returns the duration till the next job is supposed to run.

pub async fn tick(&mut self)

Increments time for the scheduler and executes any pending jobs asynchronously. It is recommended to sleep for at least 500 milliseconds between invocations of this method.

pub async fn execute(&mut self)

Executes all the job manually.

Trait Implementations

impl AsyncScheduler for AsyncJobScheduler

fn is_ready(&self) -> bool

Returns true if the scheduler is ready to run.

fn time_till_next_job(&self) -> Duration

Returns the duration till the next job is supposed to run.

async fn tick(&mut self)

Increments time for the scheduler and executes any pending jobs asynchronously.

impl Default for AsyncJobScheduler

fn default() -> AsyncJobScheduler

Returns the “default value” for a type.