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

nmea_kit/
lib.rs
