Struct sqlxmq::JobBuilder

pub struct JobBuilder<'a> { /* fields omitted */ }

Type for building a job to send.

Implementations

impl<'a> JobBuilder<'a>

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

Prepare to send a job with the specified name.

pub fn new_with_id(id: Uuid, name: &'a str) -> Self

Prepare to send a job with the specified name and ID.

pub fn set_proto<'b>(
    &'b mut self,
    proto: impl FnOnce(&'b mut Self) -> &'b mut Self
) -> &'b mut Self

Use the provided function to set any number of configuration options at once.

pub fn set_channel_name(&mut self, channel_name: &'a str) -> &mut Self

Set the channel name (default “”).

pub fn set_channel_args(&mut self, channel_args: &'a str) -> &mut Self

Set the channel arguments (default “”).

pub fn set_retries(&mut self, retries: u32) -> &mut Self

Set the number of retries after the initial attempt (default 4).

pub fn set_retry_backoff(&mut self, retry_backoff: Duration) -> &mut Self

Set the initial backoff for retries (default 1s).

pub fn set_commit_interval(
    &mut self,
    commit_interval: Option<Duration>
) -> &mut Self

Set the commit interval for two-phase commit (default disabled).

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

Set whether this job is strictly ordered with respect to other ordered job in the same channel (default false).

pub fn set_delay(&mut self, delay: Duration) -> &mut Self

Set a delay before this job is executed (default none).

pub fn set_raw_json(&mut self, raw_json: &'a str) -> &mut Self

Set a raw JSON payload for the job.

pub fn set_raw_bytes(&mut self, raw_bytes: &'a [u8]) -> &mut Self

Set a raw binary payload for the job.

pub fn set_json<T: ?Sized + Serialize>(
    &mut self,
    value: &T
) -> Result<&mut Self, Error>

Set a JSON payload for the job.

pub async fn spawn<'b, E: Executor<'b, Database = Postgres>>(
    &self,
    executor: E
) -> Result<Uuid, Error>

Spawn the job using the given executor. This might be a connection pool, a connection, or a transaction.

Trait Implementations

impl<'a> Clone for JobBuilder<'a>

fn clone(&self) -> JobBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for JobBuilder<'a>

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

Formats the value using the given formatter.