nmea-kit 0.6.0

Bidirectional NMEA 0183 parser and encoder with AIS decoding
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

//! # nmea-kit
//!
//! Bidirectional NMEA 0183 parser/encoder with AIS message decoding.
//!
//! ## Architecture
//!
//! ```text
//! raw line ──→ parse_frame() ──→ NmeaFrame { prefix, talker, sentence_type, fields }
//!                                     │
//!                      ┌──────────────┼──────────────┐
//!                      ▼              ▼               ▼
//!                $ + known      $ + unknown     ! (AIVDM/AIVDO)
//!                      │              │               │
//!                      ▼              ▼               ▼
//!               Typed struct    Raw fields      AisMessage enum
//! ```
//!
//! ## Public API
//!
//! - [`parse_frame`] / [`encode_frame`] — frame layer (always available)
//! - [`NmeaSentence`] — dispatch enum for all typed NMEA sentences
//! - [`NmeaEncodable`] — trait for encoding NMEA sentences to wire format
//! - [`ais`] — AIS decoder (behind `ais` feature)
//!
//! ## Features
//!
//! - `nmea` (default) — all 44 NMEA sentence types
//! - `ais` (default) — 16 AIS message types (read-only decode)
//! - `dbs`, `dbt`, `dpt`, … — individual sentence types

mod error;
mod frame;

// Single source of truth for the "any NMEA sentence feature is active" predicate.
// Add new sentence feature names here when wiring a new type.
macro_rules! nmea_item {
    ($item:item) => {
        #[cfg(any(
            feature = "nmea",
            feature = "aam",
            feature = "apb",
            feature = "bod",
            feature = "bwc",
            feature = "bwr",
            feature = "bww",
            feature = "dbk",
            feature = "dbs",
            feature = "dbt",
            feature = "dpt",
            feature = "dtm",
            feature = "gbs",
            feature = "gga",
            feature = "gll",
            feature = "gns",
            feature = "gsa",
            feature = "gsv",
            feature = "gst",
            feature = "hdg",
            feature = "hdm",
            feature = "hdt",
            feature = "mda",
            feature = "mtw",
            feature = "mwd",
            feature = "mwv",
            feature = "pashr",
            feature = "pgrme",
            feature = "pskpdpt",
            feature = "rmb",
            feature = "rmc",
            feature = "rot",
            feature = "rpm",
            feature = "rsa",
            feature = "rsd",
            feature = "ths",
            feature = "tll",
            feature = "ttm",
            feature = "txt",
            feature = "vbw",
            feature = "vdr",
            feature = "vhw",
            feature = "vlw",
            feature = "vtg",
            feature = "vwr",
            feature = "vwt",
            feature = "wcv",
            feature = "wpl",
            feature = "xdr",
            feature = "xte",
            feature = "zda",
        ))]
        $item
    };
}

nmea_item! { pub mod nmea; }

#[cfg(feature = "ais")]
pub mod ais;

pub use error::*;
pub use frame::*;

nmea_item! { pub use nmea::NmeaSentence; }
nmea_item! { pub use nmea::NmeaEncodable; }