prns-core 0.3.4

Pure Reticulum engine and wire contract for Personal Reticulum
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

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct InstantMillis(pub u64);

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
#[repr(transparent)]
pub struct ByteCount(pub u64);

#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum ByteLimit {
    #[default]
    Unlimited,
    Maximum(u64),
}

impl ByteLimit {
    pub const fn allows(self, byte_count: u64) -> bool {
        match self {
            Self::Unlimited => true,
            Self::Maximum(maximum) => byte_count <= maximum,
        }
    }
}

impl From<Option<u64>> for ByteLimit {
    fn from(maximum: Option<u64>) -> Self {
        match maximum {
            Some(maximum) => Self::Maximum(maximum),
            None => Self::Unlimited,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
#[repr(transparent)]
pub struct BitsPerSecond(pub u32);

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
#[repr(transparent)]
pub struct HopCount(pub u8);

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
#[repr(transparent)]
pub struct DurationMillis(pub u64);

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
#[repr(transparent)]
pub struct LinkCount(pub usize);

/// Deliberately not `Default`: zero is a genuine measurement (a sub-millisecond round trip), so a defaulted value would forge one.
/// An unmeasured RTT is an `Option<RttMillis>` instead.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct RttMillis(u64);

impl RttMillis {
    pub const fn new(millis: u64) -> RttMillis {
        RttMillis(millis)
    }

    pub const fn measured_between(sent: InstantMillis, arrived: InstantMillis) -> RttMillis {
        RttMillis(arrived.0.saturating_sub(sent.0))
    }

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

impl InstantMillis {
    pub const fn saturating_add(self, elapsed: DurationMillis) -> InstantMillis {
        InstantMillis(self.0.saturating_add(elapsed.0))
    }

    pub const fn duration_since(self, earlier: InstantMillis) -> DurationMillis {
        DurationMillis(self.0.saturating_sub(earlier.0))
    }
}

impl DurationMillis {
    pub fn from_duration_saturating(duration: core::time::Duration) -> DurationMillis {
        DurationMillis(u64::try_from(duration.as_millis()).unwrap_or(u64::MAX))
    }

    pub const fn saturating_add(self, rhs: DurationMillis) -> DurationMillis {
        DurationMillis(self.0.saturating_add(rhs.0))
    }
}

impl ByteCount {
    pub const fn saturating_add(self, rhs: ByteCount) -> ByteCount {
        ByteCount(self.0.saturating_add(rhs.0))
    }
}

impl core::iter::Sum for ByteCount {
    fn sum<I: Iterator<Item = ByteCount>>(iter: I) -> ByteCount {
        iter.fold(ByteCount(0), ByteCount::saturating_add)
    }
}