Skip to main content

Job

Struct Job 

Source
#[non_exhaustive]
pub struct Job { pub id: JobId, pub queue: String, pub payload: Bytes, pub attempt: u32, pub max_attempts: u32, pub leased_until: SystemTime, pub trace_context: Option<TraceContext>, pub cancellation: JobCancellation, pub priority: Priority, pub concurrency_key: Option<String>, /* private fields */ }
Expand description

A leased unit of work returned by Queue::dequeue.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§id: JobId

Stable id (also the natural idempotency key for consumers).

§queue: String

Source queue.

§payload: Bytes

Opaque payload.

§attempt: u32

1 on first delivery, N on the Nth.

§max_attempts: u32

Deliveries before dead-lettering.

§leased_until: SystemTime

Lease deadline; refresh with Queue::heartbeat before it passes.

§trace_context: Option<TraceContext>

Reserved cross-process W3C propagation metadata, never mixed into payload bytes.

§cancellation: JobCancellation

Cooperative application-cancellation signal.

§priority: Priority§concurrency_key: Option<String>

Implementations§

Source§

impl Job

Source

pub fn new( id: JobId, queue: String, payload: Bytes, attempt: u32, max_attempts: u32, leased_until: SystemTime, lease_token: Uuid, ) -> Self

Construct a leased job. For backend implementors: a backend mints this from a claimed row, supplying the per-lease fence lease_token that ack/nack/ heartbeat later check via Job::lease_token. App code never calls this; it receives Jobs from Queue::dequeue.

Source

pub fn with_trace_context(self, trace_context: Option<TraceContext>) -> Self

Attach stored propagation metadata when a backend materializes the lease.

Source

pub fn with_scheduling( self, priority: Priority, concurrency_key: Option<String>, ) -> Self

Source

pub fn lease_token(&self) -> Uuid

The per-lease fence token. For backend implementors: ack/nack/heartbeat must only mutate the row while it still carries this token, so a stale worker’s calls become no-ops / Precondition.

Source

pub fn payload_json<T: DeserializeOwned>(&self) -> Result<T>

Deserialize the payload from JSON. A decode failure is ForgeError::Invalid; the payload is caller data, not a backend error.

Trait Implementations§

Source§

impl Clone for Job

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Job

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !Freeze for Job

§

impl RefUnwindSafe for Job

§

impl Send for Job

§

impl Sync for Job

§

impl Unpin for Job

§

impl UnsafeUnpin for Job

§

impl UnwindSafe for Job

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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