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 36 NMEA sentence types
28//! - `ais` (default) — 16 AIS message types (read-only decode)
29//! - `dbs`, `dbt`, `dpt`, … — individual sentence types
30
31mod error;
32mod frame;
33
34#[cfg(any(
35    feature = "nmea",
36    feature = "apb",
37    feature = "bwc",
38    feature = "dbk",
39    feature = "dbs",
40    feature = "dbt",
41    feature = "dpt",
42    feature = "gbs",
43    feature = "gga",
44    feature = "gll",
45    feature = "gns",
46    feature = "gsa",
47    feature = "gsv",
48    feature = "gst",
49    feature = "hdg",
50    feature = "hdm",
51    feature = "hdt",
52    feature = "mda",
53    feature = "mtw",
54    feature = "mwd",
55    feature = "mwv",
56    feature = "pashr",
57    feature = "pgrme",
58    feature = "pskpdpt",
59    feature = "rmb",
60    feature = "rmc",
61    feature = "rot",
62    feature = "rpm",
63    feature = "rsa",
64    feature = "ths",
65    feature = "txt",
66    feature = "vbw",
67    feature = "vdr",
68    feature = "vhw",
69    feature = "vlw",
70    feature = "vtg",
71    feature = "xdr",
72    feature = "xte",
73    feature = "zda",
74))]
75pub mod nmea;
76
77#[cfg(feature = "ais")]
78pub mod ais;
79
80pub use error::*;
81pub use frame::*;
82
83#[cfg(any(
84    feature = "nmea",
85    feature = "apb",
86    feature = "dbk",
87    feature = "dbs",
88    feature = "dbt",
89    feature = "dpt",
90    feature = "gbs",
91    feature = "gga",
92    feature = "gll",
93    feature = "gns",
94    feature = "gsa",
95    feature = "gsv",
96    feature = "gst",
97    feature = "hdg",
98    feature = "hdm",
99    feature = "hdt",
100    feature = "mtw",
101    feature = "mwd",
102    feature = "mwv",
103    feature = "pashr",
104    feature = "pgrme",
105    feature = "pskpdpt",
106    feature = "rmb",
107    feature = "rmc",
108    feature = "rot",
109    feature = "rsa",
110    feature = "ths",
111    feature = "txt",
112    feature = "vbw",
113    feature = "vhw",
114    feature = "vlw",
115    feature = "bwc",
116    feature = "mda",
117    feature = "rpm",
118    feature = "vdr",
119    feature = "vtg",
120    feature = "xdr",
121    feature = "xte",
122    feature = "zda",
123))]
124pub use nmea::NmeaSentence;
125
126#[cfg(any(
127    feature = "nmea",
128    feature = "apb",
129    feature = "bwc",
130    feature = "dbk",
131    feature = "dbs",
132    feature = "dbt",
133    feature = "dpt",
134    feature = "gbs",
135    feature = "gga",
136    feature = "gll",
137    feature = "gns",
138    feature = "gsa",
139    feature = "gsv",
140    feature = "gst",
141    feature = "hdg",
142    feature = "hdm",
143    feature = "hdt",
144    feature = "mda",
145    feature = "mtw",
146    feature = "mwd",
147    feature = "mwv",
148    feature = "pashr",
149    feature = "pgrme",
150    feature = "pskpdpt",
151    feature = "rmb",
152    feature = "rmc",
153    feature = "rot",
154    feature = "rpm",
155    feature = "rsa",
156    feature = "ths",
157    feature = "txt",
158    feature = "vbw",
159    feature = "vdr",
160    feature = "vhw",
161    feature = "vlw",
162    feature = "vtg",
163    feature = "xdr",
164    feature = "xte",
165    feature = "zda",
166))]
167pub use nmea::NmeaEncodable;
nmea_kit/lib.rs

nmea_kit/
lib.rs
