Skip to main content

JobCtx

Struct JobCtx 

Source
pub struct JobCtx {
    pub id: String,
    pub queue: String,
    pub job_type: String,
    pub priority: Priority,
    pub attempt: u32,
    pub max_attempts: u32,
    pub enqueued_at: SystemTime,
    pub scheduled_at: Option<SystemTime>,
    pub custom: HashMap<String, Primitive>,
    pub trace_context: Option<TraceContext>,
    pub lease_expires_at: SystemTime,
    /* private fields */
}
Expand description

Everything about a reserved job except its payload: identity, delivery metadata, and the handle needed to manage its lease.

A handler receives this as Arc<JobCtx> alongside the payload. It also carries an internal lease handle, which is why extend can be called directly on it.

Fields§

§id: String

Server-assigned job id (a UUID).

§queue: String

The queue this job was reserved from. Useful when a worker reserves from several queues and needs to tell which one each job came from.

§job_type: String

The job type, used to route to a handler.

§priority: Priority

The job’s effective priority.

§attempt: u32

Which delivery attempt this is, starting at 1 and incremented on each redelivery.

§max_attempts: u32

The maximum attempts before the job is dead-lettered.

§enqueued_at: SystemTime

When the producer enqueued the job.

§scheduled_at: Option<SystemTime>

When the producer scheduled the job to run, if it was delayed; None for a job that was available immediately.

§custom: HashMap<String, Primitive>

Custom metadata the producer attached.

§trace_context: Option<TraceContext>

The producer’s trace context, if any and if it was well-formed.

§lease_expires_at: SystemTime

When the current lease expires. The job must be acked, nacked, or extended before this, or it will be redelivered.

Implementations§

Source§

impl JobCtx

Source

pub async fn extend( &self, extension: Duration, ) -> Result<SystemTime, LeaseError>

Extends this job’s lease by extension, measured from now, and returns the new expiry.

Use this from inside a handler that needs more time than the original lease allowed. A Worker configured with with_auto_extend does this for you.

Trait Implementations§

Source§

impl Clone for JobCtx

Source§

fn clone(&self) -> JobCtx

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 JobCtx

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for JobCtx

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !Freeze for JobCtx

§

impl !RefUnwindSafe for JobCtx

§

impl !UnwindSafe for JobCtx

§

impl Send for JobCtx

§

impl Sync for JobCtx

§

impl Unpin for JobCtx

§

impl UnsafeUnpin for JobCtx

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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