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//! ## Features
19//!
20//! - `nmea` (default) — all 23 NMEA sentence types
21//! - `ais` (default) — AIS message decoding
22//! - `dbs`, `dbt`, `dpt`, … — individual sentence types
23
24mod error;
25mod frame;
26
27#[cfg(any(
28    feature = "nmea",
29    feature = "dbk",
30    feature = "dbs",
31    feature = "dbt",
32    feature = "dpt",
33    feature = "gbs",
34    feature = "gga",
35    feature = "gll",
36    feature = "gns",
37    feature = "gst",
38    feature = "hdg",
39    feature = "hdm",
40    feature = "hdt",
41    feature = "mtw",
42    feature = "mwd",
43    feature = "mwv",
44    feature = "rmb",
45    feature = "rmc",
46    feature = "rot",
47    feature = "vbw",
48    feature = "vhw",
49    feature = "vtg",
50    feature = "xdr",
51    feature = "zda",
52))]
53pub mod nmea;
54
55#[cfg(feature = "ais")]
56pub mod ais;
57
58pub use error::*;
59pub use frame::*;
60
61#[cfg(any(
62    feature = "nmea",
63    feature = "dbk",
64    feature = "dbs",
65    feature = "dbt",
66    feature = "dpt",
67    feature = "gbs",
68    feature = "gga",
69    feature = "gll",
70    feature = "gns",
71    feature = "gst",
72    feature = "hdg",
73    feature = "hdm",
74    feature = "hdt",
75    feature = "mtw",
76    feature = "mwd",
77    feature = "mwv",
78    feature = "rmb",
79    feature = "rmc",
80    feature = "rot",
81    feature = "vbw",
82    feature = "vhw",
83    feature = "vtg",
84    feature = "zda",
85))]
86pub use nmea::NmeaSentence;
nmea_kit/lib.rs

nmea_kit/
lib.rs
