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
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

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

/// VSD — AIS Voyage Static Data.
///
/// Wire: `type_of_ship,draught,persons,destination,arrival_time,arrival_day,arrival_month,nav_status,regional`
#[derive(Debug, Clone, PartialEq)]
pub struct Vsd {
    /// Type of ship and cargo (AIS type code).
    pub type_of_ship: Option<u8>,
    /// Maximum present static draught in metres.
    pub draught: Option<f32>,
    /// Number of persons on board.
    pub persons: Option<u8>,
    /// Destination (up to 20 characters).
    pub destination: Option<String>,
    /// Estimated time of arrival (UTC, HHMM).
    pub arrival_time: Option<String>,
    /// Estimated arrival day (UTC).
    pub arrival_day: Option<u8>,
    /// Estimated arrival month (UTC).
    pub arrival_month: Option<u8>,
    /// Navigational status code.
    pub nav_status: Option<u8>,
    /// Regional reserved application identifier.
    pub regional: Option<u8>,
}

impl Vsd {
    /// 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 type_of_ship = r.u8();
        let draught = r.f32();
        let persons = r.u8();
        let destination = r.string();
        let arrival_time = r.string();
        let arrival_day = r.u8();
        let arrival_month = r.u8();
        let nav_status = r.u8();
        let regional = r.u8();
        Some(Self {
            type_of_ship,
            draught,
            persons,
            destination,
            arrival_time,
            arrival_day,
            arrival_month,
            nav_status,
            regional,
        })
    }
}

impl NmeaEncodable for Vsd {
    const SENTENCE_TYPE: &str = "VSD";

    fn encode(&self) -> Vec<String> {
        let mut w = FieldWriter::new();
        w.u8(self.type_of_ship);
        w.f32(self.draught);
        w.u8(self.persons);
        w.string(self.destination.as_deref());
        w.string(self.arrival_time.as_deref());
        w.u8(self.arrival_day);
        w.u8(self.arrival_month);
        w.u8(self.nav_status);
        w.u8(self.regional);
        w.finish()
    }
}

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

    #[test]
    fn vsd_empty() {
        let s = Vsd {
            type_of_ship: None,
            draught: None,
            persons: None,
            destination: None,
            arrival_time: None,
            arrival_day: None,
            arrival_month: None,
            nav_status: None,
            regional: None,
        }
        .to_sentence("RA");
        let f = parse_frame(s.trim()).expect("valid");
        let v = Vsd::parse(&f.fields).expect("parse");
        assert!(v.type_of_ship.is_none());
        assert!(v.destination.is_none());
    }

    #[test]
    fn vsd_encode_roundtrip() {
        let original = Vsd {
            type_of_ship: Some(0),
            draught: Some(4.5),
            persons: Some(6),
            destination: Some("PORT".to_string()),
            arrival_time: Some("220516".to_string()),
            arrival_day: Some(1),
            arrival_month: Some(2),
            nav_status: Some(8),
            regional: None,
        };
        let sentence = original.to_sentence("RA");
        let frame = parse_frame(sentence.trim()).expect("re-parse");
        let parsed = Vsd::parse(&frame.fields).expect("parse");
        assert_eq!(original, parsed);
    }

    #[test]
    fn vsd_ravsd_gonmea() {
        let frame =
            parse_frame("$RAVSD,0,4.5,6,@@@@@@@@@@@@@@@@@@@@,220516,01,02,8,*6E")
                .expect("valid");
        let v = Vsd::parse(&frame.fields).expect("parse");
        assert_eq!(v.type_of_ship, Some(0));
        assert!((v.draught.expect("draught") - 4.5).abs() < 0.01);
        assert_eq!(v.persons, Some(6));
        assert_eq!(
            v.destination.as_deref(),
            Some("@@@@@@@@@@@@@@@@@@@@")
        );
        assert_eq!(v.arrival_time.as_deref(), Some("220516"));
        assert_eq!(v.arrival_day, Some(1));
        assert_eq!(v.arrival_month, Some(2));
        assert_eq!(v.nav_status, Some(8));
        assert!(v.regional.is_none());
    }
}