rfe 0.1.0

Communicate with RF Explorer spectrum analyzers and signal generators over USB serial
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

use std::convert::TryFrom;

use nom::Parser;
use nom::{bytes::complete::tag, combinator::map_res, number::complete::u8 as nom_u8};
use num_enum::TryFromPrimitive;

use crate::common::MessageParseError;
use crate::rf_explorer::parsers::*;

#[derive(Debug, Copy, Clone, Eq, PartialEq, TryFromPrimitive, Default)]
#[repr(u8)]
/// Status of analyzer tracking mode.
pub enum TrackingStatus {
    /// Tracking mode is disabled.
    #[default]
    Disabled = 0,
    /// Tracking mode is enabled.
    Enabled,
}

impl TrackingStatus {
    pub(crate) const PREFIX: &'static [u8] = b"#K";
}

impl<'a> TryFrom<&'a [u8]> for TrackingStatus {
    type Error = MessageParseError<'a>;

    fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error> {
        // Parse the prefix of the message
        let (bytes, _) = tag(TrackingStatus::PREFIX)(bytes)?;

        // Parse the tracking status
        let (bytes, tracking_status) = map_res(nom_u8, TrackingStatus::try_from).parse(bytes)?;

        // Consume any \r or \r\n line endings and make sure there aren't any bytes left
        let _ = parse_opt_line_ending(bytes)?;

        Ok(tracking_status)
    }
}

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

    #[test]
    fn accept_valid_tracking_status_message() {
        let bytes = [b'#', b'K', 0];
        let tracking_status = TrackingStatus::try_from(bytes.as_ref()).unwrap();
        assert_eq!(tracking_status, TrackingStatus::Disabled);
    }
}