coil 0.4.0

An async and sync background job queue for Postgres
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
50
51
52
53
54
55
56
57
58
59
60

// Copyright 2018-2019 Parity Technologies (UK) Ltd.
// This file is part of coil.

// coil is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// coil is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with coil.  If not, see <http://www.gnu.org/licenses/>.

use crate::error::{EnqueueError, PerformError};
use serde::{de::DeserializeOwned, Serialize};
use sqlx::{Executor, Postgres};

/// Background job
#[async_trait::async_trait]
pub trait Job: Serialize + DeserializeOwned {
    ///  The environment this job is run with.
    ///  This is a struct you define,
    ///  which should encapsulate things like database connection pools,
    ///  any configuration, and any other static data or shared resources.
    type Environment: 'static + Send + Sync;

    /// The key to use for storing this job.
    /// Typically this is the name of your struct in `snake_case`.
    const JOB_TYPE: &'static str;
    #[doc(hidden)]

    /// inserts the job into the Postgres Database
    async fn enqueue<'a, C>(self, conn: C) -> Result<(), EnqueueError>
    where
        C: Executor<'a, Database = Postgres>,
    {
        crate::db::enqueue_job(conn, self).await
    }

    /// Logic for running a synchronous job
    #[doc(hidden)]
    fn perform(self, _: &Self::Environment, _: &sqlx::PgPool) -> Result<(), PerformError> {
        panic!("Running Sync job when it should be async!");
    }
}

#[async_trait::async_trait]
pub trait JobExt: Job {
    async fn enqueue_batch(
        data: Vec<Self>,
        conn: &mut sqlx::PgConnection,
    ) -> Result<(), EnqueueError> {
        crate::db::enqueue_jobs_batch(conn, data).await
    }
}

impl<T> JobExt for T where T: Job {}