backyard-core 0.1.0

Core traits and types for the Backyard async job queue
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

use crate::error::Result;
use async_trait::async_trait;
use chrono::{DateTime, Utc};
use std::collections::HashMap;

pub struct EnqueueRequest {
    pub job_type: String,
    pub queue: String,
    pub payload: Vec<u8>,
    pub max_retries: u32,
    pub priority: i32,
    pub scheduled_at: DateTime<Utc>,
}

pub use crate::job::{JobId, RawJob};

#[async_trait]
pub trait Queue: Send + Sync + 'static {
    async fn push(&self, req: EnqueueRequest) -> Result<JobId>;

    async fn pop(&self, queues: &[&str]) -> Result<Option<RawJob>>;

    async fn ack(&self, id: JobId) -> Result<()>;

    async fn fail(&self, id: JobId, err: &str) -> Result<()>;

    async fn retry(&self, id: JobId, retry_at: DateTime<Utc>) -> Result<()>;

    async fn get(&self, id: JobId) -> Result<Option<RawJob>>;

    async fn list(
        &self,
        queue: &str,
        status: Option<&str>,
        limit: usize,
        offset: usize,
    ) -> Result<Vec<RawJob>>;

    async fn queue_depths(&self) -> Result<HashMap<String, u64>>;
}