pgtask-core 0.2.0

Core types and state model for pgtask
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

#![doc = "Core types and state transitions for pgtask."]

mod identifier;
mod retry;
mod schedule;
mod task;

pub use identifier::{
    HandlerVersion, LeaseToken, NameError, QueueName, ScheduleId, ScheduleName, SignalName, StepName, TaskId, TaskName,
    WorkerId,
};
pub use retry::RetryPolicy;
pub use schedule::{Materialization, MisfirePolicy, Schedule, ScheduleConfig, ScheduleDefinition, ScheduleError};
pub use task::{
    Checkpoint, EnqueueRequest, EnqueueResult, LeaseRenewal, Queue, QueueConfig, Signal, Task, TaskResult, TaskState,
    WorkerRecord,
};

/// Oldest storage protocol understood by this release.
pub const STORAGE_PROTOCOL_MIN_VERSION: u32 = 1;

/// Newest storage protocol understood by this release.
pub const STORAGE_PROTOCOL_MAX_VERSION: u32 = 1;

/// Current storage protocol emitted by this release.
pub const STORAGE_PROTOCOL_VERSION: u32 = STORAGE_PROTOCOL_MAX_VERSION;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct StorageProtocolRange {
    pub minimum: u32,
    pub maximum: u32,
}

impl StorageProtocolRange {
    pub const fn new(minimum: u32, maximum: u32) -> Option<Self> {
        if minimum == 0 || maximum < minimum {
            return None;
        }
        Some(Self { minimum, maximum })
    }

    pub const fn overlaps(self, other: Self) -> bool {
        self.minimum <= other.maximum && other.minimum <= self.maximum
    }
}

pub const STORAGE_PROTOCOL_RANGE: StorageProtocolRange = StorageProtocolRange {
    minimum: STORAGE_PROTOCOL_MIN_VERSION,
    maximum: STORAGE_PROTOCOL_MAX_VERSION,
};