apalis-cron 1.0.0

A simple and extensible library for scheduling recurring tasks in rust.
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

use std::{
    marker::PhantomData,
    time::{Duration, SystemTime},
};

use crate::timezone::Utc;

/// Represents a single tick in the cron schedule
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Tick<Tz = Utc> {
    /// The timestamp of the tick in UTC
    timestamp: u64,
    _marker: PhantomData<Tz>,
}

impl<Tz> Tick<Tz> {
    /// Create a new context provided a timestamp
    pub fn new(timestamp: u64) -> Self {
        Self {
            timestamp,
            _marker: PhantomData,
        }
    }

    /// Get the inner timestamp
    pub fn get_timestamp(&self) -> u64 {
        self.timestamp
    }

    /// Returns the duration between this tick and a [`SystemTime`].
    ///
    /// The `Ok` value is returned when the tick is at or after `system_time`,
    /// while the `Err` value is returned when the tick is before `system_time`.
    pub(crate) fn signed_duration_since(&self, time: SystemTime) -> Result<Duration, Duration> {
        self.system_time()
            .duration_since(time)
            .map_err(|e| e.duration())
    }

    pub(crate) fn system_time(&self) -> SystemTime {
        SystemTime::UNIX_EPOCH + Duration::from_secs(self.timestamp)
    }
}