Struct JobBuilder

pub struct JobBuilder { /* private fields */ }

Builder for spawning a job. By default, ordered mode is off and infinite retries with capped exponential backoff is used (1 second initially, maximum 1 hour between tries).

Implementations

impl JobBuilder

pub fn new(name: &'static str) -> Self

Create new JobBuilder. By default, ordered mode is off and infinite retries with capped exponential backoff is used (1 second initially, maximum 1 hour between tries).

pub fn id(self, id: u128) -> Self

Set the message’s ID. If not set, a new random one will be generated.

pub fn ordered(self, ordered: bool) -> Self

Set whether ordered mode should be used. Ordered messages can only be executed after the previous ordered message, but unordered messages caan always be executed independently.

pub fn delay(self, delay: impl Into<Option<Duration>>) -> Self

Set initial execution delay.

pub fn max_executions(self, max_executions: impl Into<Option<u32>>) -> Self

Set the maximum number of executions. None = infinite retrying. Zero executions will result in the job never being executed!

pub fn retry_timing(self, timing: RetryTiming) -> Self

Set the retry timing strategy. See RetryTiming for the possible values.

pub fn payload_json<S: Serialize>(self, payload: S) -> Result<Self, Error>

Set JSON payload. If not set, there will be no JSON input to the job, but there can still be byte data. The payloads are independent.

pub fn payload_bytes(self, payload: Vec<u8>) -> Self

Set byte payload. If not set, there will be no byte input to the job, but there can still be JSON data. The payloads are independent.

pub async fn spawn<DB>(self, db: &DB) -> Result<u128, Error>

where DB: AsyncConnection + AsyncPubSub,

Spawn the job into the message queue on the database.

Trait Implementations

impl Clone for JobBuilder

fn clone(&self) -> JobBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JobBuilder

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

Formats the value using the given formatter.