orbit-rs 0.1.0

Fleet-aware shared-memory rings over POSIX shared memory.
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

use std::time::{Duration, SystemTime, UNIX_EPOCH};

/// Milliseconds since the Unix epoch, carried in `Frame::ver` by
/// time-sensitive Orbit primitives.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct OrbitEpoch(u64);

impl OrbitEpoch {
    pub const ZERO: Self = Self(0);

    pub fn now() -> Self {
        Self::from_system_time(SystemTime::now())
    }

    pub fn from_system_time(time: SystemTime) -> Self {
        let millis = time
            .duration_since(UNIX_EPOCH)
            .unwrap_or_default()
            .as_millis()
            .min(u128::from(u64::MAX)) as u64;
        Self(millis)
    }

    pub const fn from_unix_ms(epoch_ms: u64) -> Self {
        Self(epoch_ms)
    }

    pub const fn as_unix_ms(self) -> u64 {
        self.0
    }

    pub fn age_at(self, now: Self) -> Duration {
        Duration::from_millis(now.0.saturating_sub(self.0))
    }

    pub fn is_fresh_at(self, now: Self, max_age: Duration) -> bool {
        self.age_at(now) <= max_age
    }
}

impl From<u64> for OrbitEpoch {
    fn from(value: u64) -> Self {
        Self::from_unix_ms(value)
    }
}

impl From<OrbitEpoch> for u64 {
    fn from(value: OrbitEpoch) -> Self {
        value.as_unix_ms()
    }
}

impl std::fmt::Display for OrbitEpoch {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}