nmea_kit/
lib.rs

1//! # nmea-kit
2//!
3//! Bidirectional NMEA 0183 parser/encoder with AIS message decoding.
4//!
5//! ## Architecture
6//!
7//! ```text
8//! raw line ──→ parse_frame() ──→ NmeaFrame { prefix, talker, sentence_type, fields }
9//!                                     │
10//!                      ┌──────────────┼──────────────┐
11//!                      ▼              ▼               ▼
12//!                $ + known      $ + unknown     ! (AIVDM/AIVDO)
13//!                      │              │               │
14//!                      ▼              ▼               ▼
15//!               Typed struct    Raw fields      AisMessage enum
16//! ```
17//!
18//! ## Public API
19//!
20//! - [`parse_frame`] / [`encode_frame`] — frame layer (always available)
21//! - [`NmeaSentence`] — dispatch enum for all typed NMEA sentences
22//! - [`NmeaEncodable`] — trait for encoding NMEA sentences to wire format
23//! - [`ais`] — AIS decoder (behind `ais` feature)
24//!
25//! ## Features
26//!
27//! - `nmea` (default) — all 25 NMEA sentence types
28//! - `ais` (default) — AIS message decoding
29//! - `dbs`, `dbt`, `dpt`, … — individual sentence types
30
31mod error;
32mod frame;
33
34#[cfg(any(
35    feature = "nmea",
36    feature = "dbk",
37    feature = "dbs",
38    feature = "dbt",
39    feature = "dpt",
40    feature = "gbs",
41    feature = "gga",
42    feature = "gll",
43    feature = "gns",
44    feature = "gst",
45    feature = "hdg",
46    feature = "hdm",
47    feature = "hdt",
48    feature = "mtw",
49    feature = "mwd",
50    feature = "mwv",
51    feature = "rmb",
52    feature = "rmc",
53    feature = "rot",
54    feature = "rsa",
55    feature = "vbw",
56    feature = "vhw",
57    feature = "vlw",
58    feature = "vtg",
59    feature = "xdr",
60    feature = "zda",
61))]
62pub mod nmea;
63
64#[cfg(feature = "ais")]
65pub mod ais;
66
67pub use error::*;
68pub use frame::*;
69
70#[cfg(any(
71    feature = "nmea",
72    feature = "dbk",
73    feature = "dbs",
74    feature = "dbt",
75    feature = "dpt",
76    feature = "gbs",
77    feature = "gga",
78    feature = "gll",
79    feature = "gns",
80    feature = "gst",
81    feature = "hdg",
82    feature = "hdm",
83    feature = "hdt",
84    feature = "mtw",
85    feature = "mwd",
86    feature = "mwv",
87    feature = "rmb",
88    feature = "rmc",
89    feature = "rot",
90    feature = "rsa",
91    feature = "vbw",
92    feature = "vhw",
93    feature = "vlw",
94    feature = "vtg",
95    feature = "xdr",
96    feature = "zda",
97))]
98pub use nmea::NmeaSentence;
99
100#[cfg(any(
101    feature = "nmea",
102    feature = "dbk",
103    feature = "dbs",
104    feature = "dbt",
105    feature = "dpt",
106    feature = "gbs",
107    feature = "gga",
108    feature = "gll",
109    feature = "gns",
110    feature = "gst",
111    feature = "hdg",
112    feature = "hdm",
113    feature = "hdt",
114    feature = "mtw",
115    feature = "mwd",
116    feature = "mwv",
117    feature = "rmb",
118    feature = "rmc",
119    feature = "rot",
120    feature = "rsa",
121    feature = "vbw",
122    feature = "vhw",
123    feature = "vlw",
124    feature = "vtg",
125    feature = "xdr",
126    feature = "zda",
127))]
128pub use nmea::NmeaEncodable;
nmea_kit/lib.rs

nmea_kit/
lib.rs
