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 30 NMEA sentence types
28//! - `ais` (default) — 16 AIS message types (read-only decode)
29//! - `ais` (default) — AIS message decoding
30//! - `dbs`, `dbt`, `dpt`, … — individual sentence types
31
32mod error;
33mod frame;
34
35#[cfg(any(
36    feature = "nmea",
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 = "zda",
69))]
70pub mod nmea;
71
72#[cfg(feature = "ais")]
73pub mod ais;
74
75pub use error::*;
76pub use frame::*;
77
78#[cfg(any(
79    feature = "nmea",
80    feature = "dbk",
81    feature = "dbs",
82    feature = "dbt",
83    feature = "dpt",
84    feature = "gbs",
85    feature = "gga",
86    feature = "gll",
87    feature = "gns",
88    feature = "gsa",
89    feature = "gsv",
90    feature = "gst",
91    feature = "hdg",
92    feature = "hdm",
93    feature = "hdt",
94    feature = "mtw",
95    feature = "mwd",
96    feature = "mwv",
97    feature = "pashr",
98    feature = "pgrme",
99    feature = "pskpdpt",
100    feature = "rmb",
101    feature = "rmc",
102    feature = "rot",
103    feature = "rsa",
104    feature = "ths",
105    feature = "txt",
106    feature = "vbw",
107    feature = "vhw",
108    feature = "vlw",
109    feature = "vtg",
110    feature = "xdr",
111    feature = "zda",
112))]
113pub use nmea::NmeaSentence;
114
115#[cfg(any(
116    feature = "nmea",
117    feature = "dbk",
118    feature = "dbs",
119    feature = "dbt",
120    feature = "dpt",
121    feature = "gbs",
122    feature = "gga",
123    feature = "gll",
124    feature = "gns",
125    feature = "gsa",
126    feature = "gsv",
127    feature = "gst",
128    feature = "hdg",
129    feature = "hdm",
130    feature = "hdt",
131    feature = "mtw",
132    feature = "mwd",
133    feature = "mwv",
134    feature = "pashr",
135    feature = "pgrme",
136    feature = "pskpdpt",
137    feature = "rmb",
138    feature = "rmc",
139    feature = "rot",
140    feature = "rsa",
141    feature = "ths",
142    feature = "txt",
143    feature = "vbw",
144    feature = "vhw",
145    feature = "vlw",
146    feature = "vtg",
147    feature = "xdr",
148    feature = "zda",
149))]
150pub use nmea::NmeaEncodable;
nmea_kit/lib.rs

nmea_kit/
lib.rs
