Struct ReserveOptions 

pub struct ReserveOptions { /* private fields */ }

Parameters for a reserve call.

Constructed with ReserveOptions::new (which needs the queues to pull from and the lease duration) and refined with the with_* methods. If you use a Worker, it builds and manages these for you.

Implementations

impl ReserveOptions

pub fn new( queues: impl IntoIterator<Item = impl Into<String>>, lease_duration: Duration, ) -> Result<Self, ReserveOptionsError>

Begins reserve options for the given queues and lease duration.

Queues are polled in order: index 0 first, then index 1, and so on. The lease duration is how long a returned job is held before it must be acked, nacked, or extended. The wait timeout defaults to 30s; override it with with_wait_timeout.

At least one non-empty queue and a non-zero lease are required.

pub fn with_wait_timeout(self, wait: Duration) -> Self

Sets how long the server holds the connection open waiting for a job before returning empty. The server clamps this to its configured max_wait_timeout.

A zero (or tiny) wait makes the server answer immediately, so a naive reserve loop turns into a hot loop of back-to-back RPCs — keep a real wait for polling loops. (Worker rejects a zero wait outright and backs off on early-empty responses.)

pub fn wait_timeout(&self) -> Duration

Returns the configured long-poll wait timeout.

pub fn with_worker_id( self, id: impl Into<String>, ) -> Result<Self, ReserveOptionsError>

Sets a stable worker identifier, recorded server-side for observability. Must be non-empty.

pub fn with_max_jobs(self, max: u32) -> Self

Sets the maximum number of jobs to return in one response (default 1). The server clamps this to its max_reserve_batch. 0 is invalid: the server rejects it with INVALID_ARGUMENT on every call.

Trait Implementations

impl Clone for ReserveOptions

fn clone(&self) -> ReserveOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReserveOptions

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

Formats the value using the given formatter.

impl PartialEq for ReserveOptions

fn eq(&self, other: &ReserveOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ReserveOptions