faktory 0.13.1

API bindings for the language-agnostic Faktory work server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

use crate::error::Error;
use crate::proto::{Batch, BatchId, Client, Job};

/// Represents a newly started or re-opened batch of jobs.
pub struct BatchHandle<'a> {
    bid: BatchId,
    c: &'a mut Client,
}

impl<'a> BatchHandle<'a> {
    pub(crate) fn new(bid: BatchId, c: &mut Client) -> BatchHandle<'_> {
        BatchHandle { bid, c }
    }
}

impl BatchHandle<'_> {
    /// ID issued by the Faktory server to this batch.
    pub fn id(&self) -> &BatchId {
        &self.bid
    }
}

impl BatchHandle<'_> {
    /// Add the given job to the batch.
    ///
    /// Should the submitted job - for whatever reason - already have a `bid` key present in its custom hash,
    /// this value will be overwritten by the ID of the batch this job is being added to with the old value
    /// returned as `Some(<old value here>)`.
    pub async fn add(&mut self, mut job: Job) -> Result<Option<serde_json::Value>, Error> {
        let bid = job.custom.insert("bid".into(), self.bid.clone().into());
        self.c.enqueue(job).await.map(|_| bid)
    }

    /// Initiate a child batch of jobs.
    pub async fn start_batch(&mut self, mut batch: Batch) -> Result<BatchHandle<'_>, Error> {
        batch.parent_bid = Some(self.bid.clone());
        self.c.start_batch(batch).await
    }

    /// Commit this batch.
    ///
    /// The Faktory server will not queue any callbacks, unless the batch is committed.
    /// Committing an empty batch will make the server queue the callback(s) right away.
    /// Once committed, the batch can still be re-opened with [open_batch](Client::open_batch),
    /// and extra jobs can be added to it.
    pub async fn commit(self) -> Result<(), Error> {
        self.c.commit_batch(&self.bid).await
    }
}