mq 0.30.0

Simple Message 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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

use std::time::Duration;

use serde::{Deserialize, Serialize};
use serde_json::Value;
use serde_with::{serde_as, DurationSeconds};
use time::OffsetDateTime;

#[serde_as]
#[derive(Serialize, Deserialize, Debug)]
pub struct Job {
    id: String,
    queue: String,
    kind: String,
    #[serde(with = "time::serde::iso8601::option")]
    created_at: Option<OffsetDateTime>,
    #[serde(with = "time::serde::iso8601::option")]
    updated_at: Option<OffsetDateTime>,
    #[serde(with = "time::serde::iso8601::option")]
    scheduled_at: Option<OffsetDateTime>,
    pub(crate) payload: Value,
    error_reason: Option<Value>,
    attempts: u16,
    max_attempts: u16,
    #[serde_as(as = "DurationSeconds<u64>")]
    lease_time: Duration,
    /// Higher priority will get polled first.
    priority: u8,
    unique_key: Option<String>,
}

impl Job {
    pub fn new<K, P>(kind: K, payload: P) -> Self
    where
        K: Into<String>,
        P: Into<Value>,
    {
        Self {
            id: xid::new().to_string(),
            queue: "default".into(),
            kind: kind.into(),
            payload: payload.into(),
            error_reason: None,
            created_at: None,
            updated_at: None,
            scheduled_at: None,
            attempts: 0,
            max_attempts: 3,
            lease_time: Duration::from_secs(30),
            priority: 0,
            unique_key: None,
        }
    }

    pub fn with_queue<S: Into<String>>(mut self, queue: S) -> Self {
        self.queue = queue.into();
        self
    }

    pub fn with_new_id<S: Into<String>>(mut self) -> Self {
        self.id = xid::new().to_string();
        self
    }

    pub fn with_id<S: Into<String>>(mut self, id: S) -> Self {
        self.id = id.into();
        self
    }

    pub fn id(&self) -> &str {
        &self.id
    }

    pub fn queue(&self) -> &str {
        &self.queue
    }

    pub fn kind(&self) -> &str {
        &self.kind
    }

    pub fn created_at(&self) -> &Option<OffsetDateTime> {
        &self.created_at
    }

    pub fn updated_at(&self) -> &Option<OffsetDateTime> {
        &self.updated_at
    }

    pub fn payload(&self) -> &Value {
        &self.payload
    }

    pub fn with_attempts(mut self, attempts: u16) -> Self {
        self.attempts = attempts;
        self
    }

    pub fn attempts(&self) -> u16 {
        self.attempts
    }

    pub fn with_max_attempts(mut self, max_attempts: u16) -> Self {
        self.max_attempts = max_attempts;
        self
    }

    pub fn max_attempts(&self) -> u16 {
        self.max_attempts
    }

    pub fn with_lease_time(mut self, lease_time: Duration) -> Self {
        self.lease_time = lease_time;
        self
    }

    pub fn lease_time(&self) -> &Duration {
        &self.lease_time
    }

    pub fn with_schedule_at(mut self, date_time: OffsetDateTime) -> Self {
        self.scheduled_at = Some(date_time);
        self
    }

    pub fn with_schedule_now(mut self) -> Self {
        self.scheduled_at = None;
        self
    }

    pub fn with_schedule_in(mut self, duration: Duration) -> Self {
        self.scheduled_at = Some(OffsetDateTime::now_utc() + duration);
        self
    }

    pub fn scheduled_at(&self) -> &Option<OffsetDateTime> {
        &self.scheduled_at
    }

    pub fn with_error_reason(mut self, error_reason: Option<Value>) -> Self {
        self.error_reason = error_reason;
        self
    }

    pub fn error_reason(&self) -> &Option<Value> {
        &self.error_reason
    }

    pub fn priority(&self) -> u8 {
        self.priority
    }

    pub fn with_priority(mut self, priority: u8) -> Self {
        self.priority = priority;
        self
    }

    pub fn unique_key(&self) -> &Option<String> {
        &self.unique_key
    }

    pub fn with_unique_key(mut self, unique_key: Option<String>) -> Self {
        self.unique_key = unique_key;
        self
    }
}