Struct sqlxmq::CurrentJob

pub struct CurrentJob { /* private fields */ }

Handle to the currently executing job. When dropped, the job is assumed to no longer be running. To prevent the job being retried, it must be explicitly completed using one of the .complete_ methods.

Implementations

impl CurrentJob

pub fn pool(&self) -> &Pool<Postgres>

Returns the database pool used to receive this job.

pub async fn complete_with_transaction( &mut self, tx: Transaction<'_, Postgres> ) -> Result<(), Error>

Complete this job and commit the provided transaction at the same time. If the transaction cannot be committed, the job will not be completed.

pub async fn complete(&mut self) -> Result<(), Error>

Complete this job.

pub async fn checkpoint_with_transaction( &mut self, tx: Transaction<'_, Postgres>, checkpoint: &Checkpoint<'_> ) -> Result<(), Error>

Checkpoint this job and commit the provided transaction at the same time. If the transaction cannot be committed, the job will not be checkpointed. Checkpointing allows the job payload to be replaced for the next retry.

pub async fn checkpoint( &mut self, checkpoint: &Checkpoint<'_> ) -> Result<(), Error>

Checkpointing allows the job payload to be replaced for the next retry.

pub async fn keep_alive(&mut self, duration: Duration) -> Result<(), Error>

Prevent this job from being retried for the specified interval.

pub fn id(&self) -> Uuid

Returns the ID of this job.

pub fn name(&self) -> &str

Returns the name of this job.

pub fn json<'a, T: Deserialize<'a>>(&'a self) -> Result<Option<T>, Error>

Extracts the JSON payload belonging to this job (if present).

pub fn raw_json(&self) -> Option<&str>

Returns the raw JSON payload for this job.

pub fn raw_bytes(&self) -> Option<&[u8]>

Returns the raw binary payload for this job.

Trait Implementations

impl Debug for CurrentJob

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

Formats the value using the given formatter.

impl Drop for CurrentJob

fn drop(&mut self)

Executes the destructor for this type.