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<QueueConnection, Error>
pub async fn new(config: QueueConfig) -> Result<QueueConnection, 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
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
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 UnsafeUnpin 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
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>
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>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);