nmea-kit 0.5.6

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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

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

/// RTE — Routes.
///
/// Wire: `num_sentences,sentence_num,mode,name[,ident,…]`
#[derive(Debug, Clone, PartialEq)]
pub struct Rte {
    /// Total number of sentences needed for this route.
    pub num_sentences: Option<u8>,
    /// Sentence number in sequence.
    pub sentence_num: Option<u8>,
    /// Message mode (c=complete, w=working route).
    pub mode: Option<char>,
    /// Route name.
    pub name: Option<String>,
    /// Waypoint identifiers (variable length).
    pub idents: Vec<String>,
}

impl Rte {
    /// 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 num_sentences = r.u8();
        let sentence_num = r.u8();
        let mode = r.char();
        let name = r.string();
        let mut idents = Vec::new();
        while let Some(ident) = r.string() {
            idents.push(ident);
        }
        Some(Self {
            num_sentences,
            sentence_num,
            mode,
            name,
            idents,
        })
    }
}

impl NmeaEncodable for Rte {
    const SENTENCE_TYPE: &str = "RTE";

    fn encode(&self) -> Vec<String> {
        let mut w = FieldWriter::new();
        w.u8(self.num_sentences);
        w.u8(self.sentence_num);
        w.char(self.mode);
        w.string(self.name.as_deref());
        for ident in &self.idents {
            w.string(Some(ident.as_str()));
        }
        w.finish()
    }
}

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

    #[test]
    fn rte_empty() {
        let s = Rte {
            num_sentences: None,
            sentence_num: None,
            mode: None,
            name: None,
            idents: vec![],
        }
        .to_sentence("II");
        let f = parse_frame(s.trim()).expect("valid");
        let r = Rte::parse(&f.fields).expect("parse");
        assert!(r.num_sentences.is_none());
        assert!(r.name.is_none());
        assert!(r.idents.is_empty());
    }

    #[test]
    fn rte_encode_roundtrip() {
        let original = Rte {
            num_sentences: Some(4),
            sentence_num: Some(1),
            mode: Some('c'),
            name: Some("Rte 1".to_string()),
            idents: vec![
                "411".to_string(),
                "412".to_string(),
                "413".to_string(),
                "414".to_string(),
                "415".to_string(),
            ],
        };
        let sentence = original.to_sentence("II");
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let parsed = Rte::parse(&frame.fields).expect("parse");
        assert_eq!(original, parsed);
    }

    #[test]
    fn rte_iirte_gonmea() {
        let f = parse_frame("$IIRTE,4,1,c,Rte 1,411,412,413,414,415*6F").expect("valid RTE");
        let r = Rte::parse(&f.fields).expect("parse RTE");
        assert_eq!(r.num_sentences, Some(4));
        assert_eq!(r.sentence_num, Some(1));
        assert_eq!(r.mode, Some('c'));
        assert_eq!(r.name, Some("Rte 1".to_string()));
        assert_eq!(r.idents.len(), 5);
        assert_eq!(r.idents[0], "411");
        assert_eq!(r.idents[4], "415");
    }
}