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

nmea_kit/
lib.rs
