Skip to main content

JobResult

Enum JobResult 

Source
pub enum JobResult {
    Completed,
    RetryAfter(Duration),
    Snooze(Duration),
    Cancel(String),
    WaitForCallback(CallbackGuard),
}
Expand description

Result of executing a job handler.

§Picking the right variant for re-runs

Three primitives can put the job back on the queue. They differ in what they say about why:

PrimitiveMeansIncrements attemptDelay shape
JobError::Retryable“this attempt failed; try again”yesDB-computed exponential backoff
JobResult::RetryAfter“this attempt failed; try again after delay X”yescaller-specified
JobResult::Snooze“this attempt didn’t fail — it’s just not time yet”nocaller-specified

Rule of thumb: if every “non-success” return is a “not yet” rather than a failure (polling, waiting for an upstream signal, rate limiting), use Snooze so max_attempts keeps its plain meaning of bounding genuine failures. If the handler observed a real failure and wants a specific retry delay rather than the default exponential backoff, use RetryAfter. See awa/examples/poll_until_deadline.rs for a deadline-bounded polling example.

Variants§

§

Completed

Job completed successfully.

§

RetryAfter(Duration)

Job should be retried after the given duration. Increments attempt. Use when this attempt failed and you want a caller-specified delay instead of the default exponential backoff produced by JobError::Retryable.

§

Snooze(Duration)

Job should be re-scheduled after the given duration without counting as a failed attempt. Use for polling-style waits where each “not yet” probe is normal — max_attempts should only bound genuine handler failures, not the polling cadence.

§

Cancel(String)

Job should be cancelled. Records the reason in the job’s errors column and sets state to cancelled — no DLQ, no failure event. Use for graceful give-up (e.g. handler-side deadline expiry, user-requested abort).

§

WaitForCallback(CallbackGuard)

Job is waiting for an external callback (webhook completion).

Obtain the required guard from ctx.register_callback() or ctx.register_callback_with_config().

Trait Implementations§

Source§

impl Debug for JobResult

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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