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

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

impl BitrateBps {
    pub const MINIMUM: u64 = 5;

    #[must_use]
    pub const fn new(bps: u64) -> Option<Self> {
        if bps >= Self::MINIMUM {
            Some(Self(bps))
        } else {
            None
        }
    }

    #[must_use]
    pub const fn guess(bps: u64) -> Self {
        assert!(
            bps >= Self::MINIMUM,
            "an interface bitrate guess must meet the RNS minimum bitrate",
        );
        Self(bps)
    }

    #[must_use]
    pub const fn get(self) -> u64 {
        self.0
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn new_rejects_below_the_floor_and_accepts_from_it_up() {
        assert_eq!(BitrateBps::new(4), None);
        assert_eq!(BitrateBps::new(5).map(BitrateBps::get), Some(5));
        assert_eq!(BitrateBps::new(0), None);
        assert_eq!(
            BitrateBps::new(1_000_000).map(BitrateBps::get),
            Some(1_000_000)
        );
    }

    #[test]
    fn guess_holds_a_compile_time_default() {
        const GIGABIT: BitrateBps = BitrateBps::guess(1_000_000_000);
        assert_eq!(GIGABIT.get(), 1_000_000_000);
    }

    #[test]
    #[should_panic(expected = "RNS minimum bitrate")]
    fn guess_below_the_floor_panics() {
        let _ = BitrateBps::guess(4);
    }
}