Struct MemoryQueue 

pub struct MemoryQueue { /* private fields */ }

A process-local queue. Cloning shares one store, so it can be registered as application state and handed to every handler and worker.

Implementations

impl MemoryQueue

pub fn new() -> Self

pub fn ready_size(&self, queue: &str) -> Result<u64>

How many jobs are ready to run right now, as opposed to Queue::size, which counts delayed ones too. Useful for asserting in a test that a delay is actually holding a job back.

pub fn flush_failed(&self) -> Result<u64>

Empty the dead-letter store. queue:flush in Laravel.

Trait Implementations

impl Clone for MemoryQueue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for MemoryQueue

fn default() -> Self

Returns the “default value” for a type.

impl Queue for MemoryQueue

fn driver(&self) -> &'static str

The driver’s name. It appears in queue.* events and error messages, which is how Telescope shows which backend handled a job.

fn push(&self, job: QueuedJob) -> BoxFuture<'_, Result<String>>

Store a job. Returns the driver’s identifier for it.

fn pop<'a>( &'a self, queue: &'a str, ) -> BoxFuture<'a, Result<Option<ReservedJob>>>

Reserve the next available job, or None when there is nothing ready.

fn size<'a>(&'a self, queue: &'a str) -> BoxFuture<'a, Result<u64>>

How many jobs are waiting on a queue, including delayed ones.

fn delete<'a>(&'a self, _job: &'a ReservedJob) -> BoxFuture<'a, Result<()>>

Finish with a reserved job: it succeeded and is gone.

fn release<'a>( &'a self, job: &'a ReservedJob, delay: Duration, ) -> BoxFuture<'a, Result<()>>

Put a reserved job back, available again after delay.

fn fail<'a>( &'a self, job: &'a ReservedJob, error: &'a str, ) -> BoxFuture<'a, Result<()>>

Move a reserved job to the dead-letter store with the error that killed it. It must no longer be on the queue afterwards.

fn failed_jobs(&self) -> BoxFuture<'_, Result<Vec<FailedJob>>>

Everything in the dead-letter store, oldest first.

fn clear<'a>(&'a self, queue: &'a str) -> BoxFuture<'a, Result<u64>>

Throw away every job waiting on a queue. Returns how many went.

fn push_on<'a>( &'a self, queue: &'a str, job: QueuedJob, ) -> BoxFuture<'a, Result<String>>

Store a job on a named queue, whatever the job itself asked for.

fn later<'a>( &'a self, delay: Duration, job: QueuedJob, ) -> BoxFuture<'a, Result<String>>

Store a job that only becomes visible to a worker after delay.