ham-cats 0.3.1

Reference implementations for CATS, the ham radio protocol
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
59
60
61
62
63

use arrayvec::ArrayString;

use crate::identity::Identity;

#[derive(Debug, PartialEq, Eq, Clone)]
pub struct Identification {
    pub callsign: ArrayString<252>,
    pub ssid: u8,
    pub icon: u16,
}

impl Identification {
    pub fn new(call: &str, ssid: u8, icon: u16) -> Option<Self> {
        let callsign = ArrayString::from(call).ok()?;

        Some(Self {
            icon,
            callsign,
            ssid,
        })
    }

    pub fn as_identity(&self) -> Identity<'_> {
        Identity::new(&self.callsign, self.ssid)
    }

    /// Returns none if there is not enough space in the buffer
    pub fn encode<'a>(&self, buf: &'a mut [u8]) -> Option<&'a [u8]> {
        // safe to unwrap because we know the length is <= 252
        let len: u8 = self.callsign.len().try_into().unwrap();
        *buf.get_mut(0)? = len + 3;

        buf.get_mut(1..3)?.copy_from_slice(&self.icon.to_le_bytes());

        let mut len = 3;
        for (i, b) in self.callsign.as_bytes().iter().enumerate() {
            *buf.get_mut(i + 3)? = *b;
            len += 1
        }

        *buf.get_mut(len)? = self.ssid;
        len += 1;

        Some(&buf[0..len])
    }

    pub fn decode(data: &[u8]) -> Option<Self> {
        let len = (*data.first()?).into();

        let icon = u16::from_le_bytes([*data.get(1)?, *data.get(2)?]);

        let callsign = core::str::from_utf8(data.get(3..len)?).ok()?;
        let callsign = ArrayString::from(callsign).ok()?;

        let ssid = *data.get(len)?;

        Some(Self {
            icon,
            callsign,
            ssid,
        })
    }
}