Trait AsyncScheduler

pub trait AsyncScheduler {
    // Required methods
    fn is_ready(&self) -> bool;
    fn is_blocking(&self) -> bool;
    fn time_till_next_job(&self) -> Option<Duration>;
    fn tick(&mut self) -> impl Future<Output = ()> + Send;
    fn run(self) -> impl Future<Output = Result<()>> + Send;
}

An interface for scheduling async jobs.

Required Methods

fn is_ready(&self) -> bool

Returns true if the scheduler is ready to run.

fn is_blocking(&self) -> bool

Returns true if the scheduler is blocking.

fn time_till_next_job(&self) -> Option<Duration>

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

fn tick(&mut self) -> impl Future<Output = ()> + Send

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

fn run(self) -> impl Future<Output = Result<()>> + Send

Runs the scheduler and returns an std::io::Error if failed.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl AsyncScheduler for Monitor

Available on crate feature apalis only.

fn is_ready(&self) -> bool

fn is_blocking(&self) -> bool

fn time_till_next_job(&self) -> Option<Duration>

async fn tick(&mut self)

async fn run(self) -> Result<()>

Implementors

impl AsyncScheduler for AsyncJobScheduler