nmea0183-parser 0.3.2

A zero-allocation NMEA 0183 parser that separates message framing from content parsing
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
138
139
140
141
142

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use crate::{self as nmea0183_parser, NmeaParse};

/// DPT - Depth of Water
///
/// <https://gpsd.gitlab.io/gpsd/NMEA.html#_dpt_depth_of_water>
///
/// ```text
///         1   2
///         |   |
///  $--DPT,x.x,x.x*hh<CR><LF>
/// ```
///
/// NMEA 3.0:
/// ```text
///        1   2   3
///        |   |   |
/// $--DPT,x.x,x.x,x.x*hh<CR><LF>
/// ```
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
#[derive(Debug, Default, Clone, PartialEq, NmeaParse)]
pub struct DPT {
    /// Water depth relative to transducer in meters
    pub water_depth: Option<f32>,
    /// Offset from transducer in meters,
    /// positive means distance from transducer to water line,
    /// negative means distance from transducer to keel
    pub offset_from_transducer: Option<f32>,
    #[cfg(feature = "nmea-v3-0")]
    #[cfg_attr(docsrs, doc(cfg(feature = "nmea-v3-0")))]
    /// Maximum range scale in used for the measurement in meters
    pub max_range_scale: Option<f32>,
}

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

    #[cfg(not(feature = "nmea-v3-0"))]
    #[test]
    fn test_dpt_parsing() {
        let compares = [
            (
                "10.0,2.0",
                DPT {
                    water_depth: Some(10.0),
                    offset_from_transducer: Some(2.0),
                    #[cfg(feature = "nmea-v3-0")]
                    max_range_scale: None,
                },
            ),
            (
                ",2.0",
                DPT {
                    water_depth: None,
                    offset_from_transducer: Some(2.0),
                    #[cfg(feature = "nmea-v3-0")]
                    max_range_scale: None,
                },
            ),
            (
                "10.0,",
                DPT {
                    water_depth: Some(10.0),
                    offset_from_transducer: None,
                    #[cfg(feature = "nmea-v3-0")]
                    max_range_scale: None,
                },
            ),
        ];

        for (input, expected) in compares {
            let result: IResult<_, _> = DPT::parse(input);
            if let Ok((remaining, parsed)) = result {
                assert!(
                    remaining.is_empty(),
                    "Expected no remaining input, got: {:?}",
                    remaining
                );
                assert_eq!(parsed.water_depth, expected.water_depth);
                assert_eq!(
                    parsed.offset_from_transducer,
                    expected.offset_from_transducer
                );
            } else {
                let error = result.unwrap_err();
                eprintln!("Failed to parse {:?} - error {:?}", input, error);
                panic!("Failed to parse");
            }
        }
    }

    #[cfg(feature = "nmea-v3-0")]
    #[test]
    fn test_dpt_parsing_v3_0() {
        let compares = [
            (
                "10.0,2.0,20.0",
                DPT {
                    water_depth: Some(10.0),
                    offset_from_transducer: Some(2.0),
                    max_range_scale: Some(20.0),
                },
            ),
            (
                ",2.0,",
                DPT {
                    water_depth: None,
                    offset_from_transducer: Some(2.0),
                    max_range_scale: None,
                },
            ),
            (
                "10.0,,",
                DPT {
                    water_depth: Some(10.0),
                    offset_from_transducer: None,
                    max_range_scale: None,
                },
            ),
        ];

        for (input, expected) in compares {
            let result: IResult<_, _> = DPT::parse(input);
            if let Ok((remaining, parsed)) = result {
                assert!(remaining.is_empty());
                assert_eq!(parsed.water_depth, expected.water_depth);
                assert_eq!(
                    parsed.offset_from_transducer,
                    expected.offset_from_transducer
                );
                assert_eq!(parsed.max_range_scale, expected.max_range_scale);
            } else {
                panic!("Failed to parse DPT with v3.0");
            }
        }
    }
}