nmea-kit 0.5.0

Bidirectional NMEA 0183 parser and encoder with AIS decoding
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
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

use crate::nmea::field::{FieldReader, FieldWriter, NmeaEncodable};

/// EVE — General Event Message.
///
/// Wire: `time,tag_code,message`
#[derive(Debug, Clone, PartialEq)]
pub struct Eve {
    /// Event time.
    pub time: Option<String>,
    /// Tag/code identifier.
    pub tag_code: Option<String>,
    /// Event message text.
    pub message: Option<String>,
}

impl Eve {
    /// Parse fields from a decoded NMEA frame.
    /// Always returns `Some`; missing or malformed fields become `None`.
    pub fn parse(fields: &[&str]) -> Option<Self> {
        let mut r = FieldReader::new(fields);
        let time = r.string();
        let tag_code = r.string();
        let message = r.string();
        Some(Self {
            time,
            tag_code,
            message,
        })
    }
}

impl NmeaEncodable for Eve {
    const SENTENCE_TYPE: &str = "EVE";

    fn encode(&self) -> Vec<String> {
        let mut w = FieldWriter::new();
        w.string(self.time.as_deref());
        w.string(self.tag_code.as_deref());
        w.string(self.message.as_deref());
        w.finish()
    }
}

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

    #[test]
    fn eve_empty() {
        let s = Eve {
            time: None,
            tag_code: None,
            message: None,
        }
        .to_sentence("FR");
        let f = parse_frame(s.trim()).expect("valid");
        let e = Eve::parse(&f.fields).expect("parse");
        assert!(e.time.is_none());
        assert!(e.message.is_none());
    }

    #[test]
    fn eve_encode_roundtrip() {
        let original = Eve {
            time: Some("000001".to_string()),
            tag_code: Some("DZ00513".to_string()),
            message: Some("Fire Alarm".to_string()),
        };
        let sentence = original.to_sentence("FR");
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let parsed = Eve::parse(&frame.fields).expect("parse");
        assert_eq!(original, parsed);
    }

    #[test]
    fn eve_freve_gonmea() {
        let frame =
            parse_frame("$FREVE,000001,DZ00513,Fire Alarm On: TEST DZ201 Name*0A").expect("valid");
        let e = Eve::parse(&frame.fields).expect("parse");
        assert_eq!(e.time.as_deref(), Some("000001"));
        assert_eq!(e.tag_code.as_deref(), Some("DZ00513"));
        assert_eq!(
            e.message.as_deref(),
            Some("Fire Alarm On: TEST DZ201 Name")
        );
    }
}