Struct Queue 

pub struct Queue { /* private fields */ }

The queue handle. Cheap to clone: every clone is the same queue.

Implementations

impl Queue

pub fn new( driver: impl QueueDriver + 'static, jobs: impl IntoIterator<Item = JobReg>, services: Services, options: Options, ) -> Self

A queue over driver, knowing jobs.

pub fn inline( jobs: impl IntoIterator<Item = JobReg>, services: Services, ) -> Self

A queue that runs every job as it is pushed, over no storage: for tests and tools.

pub fn mode(&self) -> Mode

pub fn driver_name(&self) -> &'static str

pub fn job_names(&self) -> Vec<&'static str>

The names of every registered job, sorted.

pub async fn push<T: Job>(&self, job: &T) -> CoreResult<Pushed>

Pushes job, due now.

pub async fn push_in<T: Job>( &self, job: &T, delay: Duration, ) -> CoreResult<Pushed>

Pushes job, due after delay.

pub async fn push_at<T: Job>( &self, job: &T, when: DateTime<Utc>, ) -> CoreResult<Pushed>

Pushes job, due at when.

pub async fn push_named( &self, name: &str, payload: &Value, queue: &str, ) -> CoreResult<Pushed>

Pushes a job by its registered name with a payload already encoded, due now: what a schedule entry does. Refused when no job has the name.

pub async fn counts(&self) -> CoreResult<Vec<QueueCount>>

How many jobs each queue holds.

pub async fn failed(&self) -> CoreResult<Vec<FailedJob>>

The failed list, newest first.

pub async fn retry(&self, id: Option<i64>) -> CoreResult<usize>

Puts one failed job, or every one, back on its queue.

pub async fn forget(&self, id: Option<i64>) -> CoreResult<usize>

Drops one failed job, or every one.

pub async fn clear(&self, queue: Option<&str>) -> CoreResult<usize>

Drops every waiting job on queue, or everywhere.

pub async fn work( &self, options: WorkOptions, stop: Receiver<bool>, ) -> CoreResult<usize>

Runs jobs on this task until stop says so, or as options end it. Returns how many jobs it processed.

pub fn spawn_workers(&self, stop: Receiver<bool>) -> Vec<JoinHandle<()>>

Starts the configured number of workers, each taking from the configured queues, until stop says so.

Trait Implementations

impl Clone for Queue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Queue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.