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 38 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// Single source of truth for the "any NMEA sentence feature is active" predicate.
35// Add new sentence feature names here when wiring a new type.
36macro_rules! nmea_item {
37 ($item:item) => {
38 #[cfg(any(
39 feature = "nmea",
40 feature = "apb",
41 feature = "bwc",
42 feature = "bwr",
43 feature = "dbk",
44 feature = "dbs",
45 feature = "dbt",
46 feature = "dpt",
47 feature = "dtm",
48 feature = "gbs",
49 feature = "gga",
50 feature = "gll",
51 feature = "gns",
52 feature = "gsa",
53 feature = "gsv",
54 feature = "gst",
55 feature = "hdg",
56 feature = "hdm",
57 feature = "hdt",
58 feature = "mda",
59 feature = "mtw",
60 feature = "mwd",
61 feature = "mwv",
62 feature = "pashr",
63 feature = "pgrme",
64 feature = "pskpdpt",
65 feature = "rmb",
66 feature = "rmc",
67 feature = "rot",
68 feature = "rpm",
69 feature = "rsa",
70 feature = "ths",
71 feature = "txt",
72 feature = "vbw",
73 feature = "vdr",
74 feature = "vhw",
75 feature = "vlw",
76 feature = "vtg",
77 feature = "vwr",
78 feature = "wpl",
79 feature = "xdr",
80 feature = "xte",
81 feature = "zda",
82 ))]
83 $item
84 };
85}
86
87nmea_item! { pub mod nmea; }
88
89#[cfg(feature = "ais")]
90pub mod ais;
91
92pub use error::*;
93pub use frame::*;
94
95nmea_item! { pub use nmea::NmeaSentence; }
96nmea_item! { pub use nmea::NmeaEncodable; }