pub struct QueueConnection { /* private fields */ }Expand description
A connection to the queue backend.
Implementations§
Source§impl QueueConnection
impl QueueConnection
Sourcepub async fn new(config: QueueConfig) -> Result<Self, Error>
pub async fn new(config: QueueConfig) -> Result<Self, Error>
Create a new queue connection.
Sourcepub fn config(&self) -> &QueueConfig
pub fn config(&self) -> &QueueConfig
Get the configuration.
Sourcepub async fn pop(&self, queue: &str) -> Result<Option<JobPayload>, Error>
pub async fn pop(&self, queue: &str) -> Result<Option<JobPayload>, Error>
Pop a job from a queue (blocking).
Sourcepub async fn pop_nowait(&self, queue: &str) -> Result<Option<JobPayload>, Error>
pub async fn pop_nowait(&self, queue: &str) -> Result<Option<JobPayload>, Error>
Pop a job from a queue (non-blocking).
Sourcepub async fn migrate_delayed(&self, queue: &str) -> Result<usize, Error>
pub async fn migrate_delayed(&self, queue: &str) -> Result<usize, Error>
Move delayed jobs that are ready to the main queue.
Sourcepub async fn release(
&self,
payload: JobPayload,
delay: Duration,
) -> Result<(), Error>
pub async fn release( &self, payload: JobPayload, delay: Duration, ) -> Result<(), Error>
Release a job back to the queue (for retry).
Sourcepub async fn fail(
&self,
payload: JobPayload,
error: &Error,
) -> Result<(), Error>
pub async fn fail( &self, payload: JobPayload, error: &Error, ) -> Result<(), Error>
Mark a job as failed.
Sourcepub async fn size(&self, queue: &str) -> Result<usize, Error>
pub async fn size(&self, queue: &str) -> Result<usize, Error>
Get the number of jobs in a queue.
Sourcepub async fn delayed_size(&self, queue: &str) -> Result<usize, Error>
pub async fn delayed_size(&self, queue: &str) -> Result<usize, Error>
Get the number of delayed jobs in a queue.
Sourcepub async fn get_pending_jobs(
&self,
queue: &str,
limit: usize,
) -> Result<Vec<JobInfo>, Error>
pub async fn get_pending_jobs( &self, queue: &str, limit: usize, ) -> Result<Vec<JobInfo>, Error>
Get pending jobs from a queue (without removing them).
Sourcepub async fn get_delayed_jobs(
&self,
queue: &str,
limit: usize,
) -> Result<Vec<JobInfo>, Error>
pub async fn get_delayed_jobs( &self, queue: &str, limit: usize, ) -> Result<Vec<JobInfo>, Error>
Get delayed jobs from a queue (without removing them).
Sourcepub async fn get_failed_jobs(
&self,
limit: usize,
) -> Result<Vec<FailedJobInfo>, Error>
pub async fn get_failed_jobs( &self, limit: usize, ) -> Result<Vec<FailedJobInfo>, Error>
Get failed jobs (without removing them).
Sourcepub async fn failed_count(&self) -> Result<usize, Error>
pub async fn failed_count(&self) -> Result<usize, Error>
Get the count of failed jobs.
Trait Implementations§
Source§impl Clone for QueueConnection
impl Clone for QueueConnection
Source§fn clone(&self) -> QueueConnection
fn clone(&self) -> QueueConnection
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for QueueConnection
impl !RefUnwindSafe for QueueConnection
impl Send for QueueConnection
impl Sync for QueueConnection
impl Unpin for QueueConnection
impl !UnwindSafe for QueueConnection
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more