Skip to main content

AddJob

Struct AddJob 

Source
pub struct AddJob<'a> { /* private fields */ }
Expand description

Fluent builder returned by Queue::add.

AddJob implements IntoFuture, so awaiting it adds the job with the accumulated options. Setters are infallible and chainable; any invalid configuration (or a data serialization failure) is reported when the builder is awaited.

Implementations§

Source§

impl<'a> AddJob<'a>

Source

pub fn options(self, opts: JobOptions) -> Self

Use opts as the base options, replacing anything set so far.

Useful for reusing a prepared JobOptions; subsequent setters still override individual fields.

Source

pub fn delay(self, delay: Duration) -> Self

Delay before the job becomes available for processing.

Source

pub fn priority(self, priority: u32) -> Self

Job priority. Lower values are processed first; unset (or 0) means the job is not prioritized and follows normal FIFO/LIFO ordering.

Source

pub fn attempts(self, attempts: u32) -> Self

Total number of attempts before the job permanently fails.

Source

pub fn backoff(self, backoff: BackoffStrategy) -> Self

Backoff strategy applied between retries.

Source

pub fn lifo(self) -> Self

Add the job to the back of the queue (last-in-first-out ordering).

Source

pub fn job_id(self, id: impl Into<String>) -> Self

Use a custom, unique job id instead of an auto-generated one.

Source

pub fn remove_on_complete(self, policy: RemoveOnFinish) -> Self

Completed-job retention policy.

Source

pub fn remove_on_fail(self, policy: RemoveOnFinish) -> Self

Failed-job retention policy.

Source

pub fn keep_logs(self, count: u32) -> Self

Maximum number of log entries to retain for the job.

Source

pub fn parent(self, parent: ParentOptions) -> Self

Attach this job to a parent job (flow / dependency chains).

Source

pub fn deduplication(self, deduplication: DeduplicationOptions) -> Self

Deduplicate the job using the given options.

Source

pub fn size_limit(self, bytes: usize) -> Self

Reject the job if its serialized payload exceeds bytes UTF-8 bytes.

Trait Implementations§

Source§

impl<'a> IntoFuture for AddJob<'a>

Source§

type Output = Result<Job, Error>

The output that the future will produce on completion.
Source§

type IntoFuture = Pin<Box<dyn Future<Output = <AddJob<'a> as IntoFuture>::Output> + Send + 'a>>

Which kind of future are we turning this into?
Source§

fn into_future(self) -> Self::IntoFuture

Creates a future from a value. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for AddJob<'a>

§

impl<'a> !UnwindSafe for AddJob<'a>

§

impl<'a> Freeze for AddJob<'a>

§

impl<'a> Send for AddJob<'a>

§

impl<'a> Sync for AddJob<'a>

§

impl<'a> Unpin for AddJob<'a>

§

impl<'a> UnsafeUnpin for AddJob<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more