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

//! Parser for the GGA sentence of the NMEA 0183 protocol.
//!
//! This parser accepts data as described
//! [here](http://www.catb.org/gpsd/NMEA.html#_gga_global_positioning_system_fix_data).
//!
//! # Setup
//!
//! Add this to `Cargo.toml`:
//! ```toml
//! [dependencies]
//! titanic = "0.1.0"
//! ```
//!
//! Then put this in your crate root:
//!
//! ```rust
//! extern crate titanic;
//! ```
//!
//! # Usage
//!
//! [`GgaParser`](./parser/struct.GgaParser.html) can be used like an
//! [`Iterator`](https://doc.rust-lang.org/std/iter/trait.Iterator.html).
//! Calling `next()` on `GgaParser` **blocks** until it finds `'$'`,
//! reaches EOF or an I/O error occurs. `'$'` signals the beginning of a new sentence.
//! If the new sentence is of the type GGA, it will be parsed if possible.
//! Parser iterates over `Result<GgaSentence, ParseError>`.
//!
//! EOF signals the end of the iterator.
//!
//! ```rust
//! # extern crate titanic;
//! # use std::io::Cursor;
//! use titanic::GgaParser;
//!
//! # let data = Cursor::new("$GPGGA,142212.000,1956.9418,S,06938.0163,W,1,3,5.74,102.1,M,47.9,M,,*57");
//! let parser = GgaParser::new(data).unwrap();
//!
//! for gga in parser {
//!     let gga = gga.unwrap();
//!     println!(
//!        "Time: {}, we are here: {}°, {}°",
//!        gga.utc.format("%H:%M:%S"),
//!        gga.lat.unwrap(),
//!        gga.long.unwrap()
//!    );
//! }
//! // Prints "Time: 14:22:12, we are here: -19.94903°, -69.633605°"
//! ```
//!
#![forbid(unsafe_code)]

#[cfg(test)]
#[macro_use]
extern crate assert_matches;
extern crate arrayvec;
extern crate chrono;
#[macro_use]
extern crate quick_error;

pub mod err;
#[macro_use]
mod macros;
mod lexer;
pub mod parser;

pub use parser::{GgaParser, GgaSentence};