pub struct Queue<B: QueueBackend> { /* private fields */ }Expand description
High-level queue interface
Implementations§
Source§impl<B: QueueBackend> Queue<B>
impl<B: QueueBackend> Queue<B>
Sourcepub async fn enqueue<T: Job>(
&self,
job: T,
priority: Option<Priority>,
) -> QueueResult<JobId>
pub async fn enqueue<T: Job>( &self, job: T, priority: Option<Priority>, ) -> QueueResult<JobId>
Enqueue a job
Sourcepub async fn enqueue_delayed<T: Job>(
&self,
job: T,
delay: Duration,
priority: Option<Priority>,
) -> QueueResult<JobId>
pub async fn enqueue_delayed<T: Job>( &self, job: T, delay: Duration, priority: Option<Priority>, ) -> QueueResult<JobId>
Enqueue a delayed job
Sourcepub async fn dequeue(&self) -> QueueResult<Option<JobEntry>>
pub async fn dequeue(&self) -> QueueResult<Option<JobEntry>>
Dequeue the next available job
Sourcepub async fn complete(
&self,
job_id: JobId,
result: JobResult<()>,
) -> QueueResult<()>
pub async fn complete( &self, job_id: JobId, result: JobResult<()>, ) -> QueueResult<()>
Mark a job as completed
Sourcepub async fn get_jobs_by_state(
&self,
state: JobState,
limit: Option<usize>,
) -> QueueResult<Vec<JobEntry>>
pub async fn get_jobs_by_state( &self, state: JobState, limit: Option<usize>, ) -> QueueResult<Vec<JobEntry>>
Get jobs by state
Sourcepub async fn remove_job(&self, job_id: JobId) -> QueueResult<bool>
pub async fn remove_job(&self, job_id: JobId) -> QueueResult<bool>
Remove a job from the queue
Sourcepub async fn clear(&self) -> QueueResult<()>
pub async fn clear(&self) -> QueueResult<()>
Clear all jobs from the queue
Sourcepub async fn stats(&self) -> QueueResult<QueueStats>
pub async fn stats(&self) -> QueueResult<QueueStats>
Get queue statistics
Auto Trait Implementations§
impl<B> Freeze for Queue<B>where
B: Freeze,
impl<B> RefUnwindSafe for Queue<B>where
B: RefUnwindSafe,
impl<B> Send for Queue<B>
impl<B> Sync for Queue<B>
impl<B> Unpin for Queue<B>where
B: Unpin,
impl<B> UnwindSafe for Queue<B>where
B: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more