nmea_kit/
lib.rs

1#![cfg_attr(
2    not(test),
3    deny(
4        clippy::panic,
5        clippy::expect_used,
6        clippy::todo,
7        clippy::unimplemented,
8        clippy::unreachable
9    )
10)]
11//! # nmea-kit
12//!
13//! Bidirectional NMEA 0183 parser/encoder with AIS message decoding.
14//!
15//! ## Architecture
16//!
17//! ```text
18//! raw line ──→ parse_frame() ──→ NmeaFrame { prefix, talker, sentence_type, fields }
19//!                                     │
20//!                      ┌──────────────┼──────────────┐
21//!                      ▼              ▼               ▼
22//!                $ + known      $ + unknown     ! (AIVDM/AIVDO)
23//!                      │              │               │
24//!                      ▼              ▼               ▼
25//!               Typed struct    Raw fields      AisMessage enum
26//! ```
27//!
28//! ## Public API
29//!
30//! - [`parse_frame`] / [`encode_frame`] — frame layer (always available)
31//! - [`NmeaSentence`] — dispatch enum for all typed NMEA sentences
32//! - [`NmeaEncodable`] — trait for encoding NMEA sentences to wire format
33//! - [`ais`] — AIS decoder (behind `ais` feature)
34//!
35//! ## Features
36//!
37//! - `nmea` (default) — all 58 NMEA sentence types
38//! - `ais` (default) — 16 AIS message types (read-only decode)
39//! - `dbs`, `dbt`, `dpt`, … — individual sentence types
40
41mod error;
42mod frame;
43
44// Single source of truth for the "any NMEA sentence feature is active" predicate.
45// Add new sentence feature names here when wiring a new type.
46macro_rules! nmea_item {
47    ($item:item) => {
48        #[cfg(any(
49            feature = "nmea",
50            feature = "ack",
51            feature = "aam",
52            feature = "apb",
53            feature = "bec",
54            feature = "bod",
55            feature = "bwc",
56            feature = "bwr",
57            feature = "bww",
58            feature = "dbk",
59            feature = "dbs",
60            feature = "dbt",
61            feature = "dpt",
62            feature = "dtm",
63            feature = "gbs",
64            feature = "gga",
65            feature = "gll",
66            feature = "gns",
67            feature = "gsa",
68            feature = "gsv",
69            feature = "gst",
70            feature = "hbt",
71            feature = "hdg",
72            feature = "hdm",
73            feature = "hdt",
74            feature = "hsc",
75            feature = "mda",
76            feature = "mta",
77            feature = "mtw",
78            feature = "mwd",
79            feature = "mwv",
80            feature = "osd",
81            feature = "pashr",
82            feature = "pgrme",
83            feature = "pskpdpt",
84            feature = "rmb",
85            feature = "rmc",
86            feature = "rot",
87            feature = "rpm",
88            feature = "rsa",
89            feature = "rsd",
90            feature = "rte",
91            feature = "ths",
92            feature = "tll",
93            feature = "ttm",
94            feature = "txt",
95            feature = "vbw",
96            feature = "vdr",
97            feature = "vhw",
98            feature = "vlw",
99            feature = "vpw",
100            feature = "vtg",
101            feature = "vwr",
102            feature = "vwt",
103            feature = "wcv",
104            feature = "wpl",
105            feature = "xdr",
106            feature = "xte",
107            feature = "zda",
108        ))]
109        $item
110    };
111}
112
113nmea_item! { pub mod nmea; }
114
115#[cfg(feature = "ais")]
116pub mod ais;
117
118pub use error::*;
119pub use frame::*;
120
121nmea_item! { pub use nmea::NmeaSentence; }
122nmea_item! { pub use nmea::NmeaEncodable; }
nmea_kit/lib.rs

nmea_kit/
lib.rs
