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

nmea_kit/
lib.rs
