Struct background_jobs::QueueHandle

pub struct QueueHandle { /* fields omitted */ }

A handle to the job server, used for queuing new jobs

QueueHandle should be stored in your application’s state in order to allow all parts of your application to spawn jobs.

Implementations

impl QueueHandle

pub fn queue<J>(&self, job: J) -> Result<(), Error> where
    J: Job, 

Queues a job for execution

This job will be sent to the server for storage, and will execute whenever a worker for the job’s queue is free to do so.

pub fn schedule<J>(&self, job: J, after: DateTime<Utc>) -> Result<(), Error> where
    J: Job, 

Schedule a job for execution later

This job will be sent to the server for storage, and will execute after the specified time and when a worker for the job’s queue is free to do so.

pub fn every<J>(&self, duration: Duration, job: J) where
    J: 'static + Job + Clone + Send, 

Queues a job for recurring execution

This job will be added to it’s queue on the server once every Duration. It will be processed whenever workers are free to do so.

pub async fn get_stats(&'_ self) -> Result<Stats, Error>

Return an overview of the processor’s statistics

Trait Implementations

impl Clone for QueueHandle

pub fn clone(&self) -> QueueHandle

Returns a copy of the value.

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

Performs copy-assignment from source.