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

//! gpx is a library for reading and writing GPX (GPS Exchange Format) files.
//! It uses the primitives provided by [geo-types](https://github.com/georust/geo)
//! to allow for storage of GPS data.
//!
//! # Examples
//! ```
//! use std::io::BufReader;
//! use std::fs::File;
//!
//! use gpx::read;
//! use gpx::{Gpx, Track, TrackSegment};
//!
//! // This XML file actually exists — try it for yourself!
//! let file = File::open("tests/fixtures/wikipedia_example.gpx").unwrap();
//! let reader = BufReader::new(file);
//!
//! // read takes any io::Read and gives a Result<Gpx, Error>.
//! let gpx: Gpx = read(reader).unwrap();
//!
//! // Each GPX file has multiple "tracks", this takes the first one.
//! let track: &Track = &gpx.tracks[0];
//! assert_eq!(track.name, Some(String::from("Example GPX Document")));
//!
//! // Each track will have different segments full of waypoints, where a
//! // waypoint contains info like latitude, longitude, and elevation.
//! let segment: &TrackSegment = &track.segments[0];
//!
//! // This is an example of retrieving the elevation (in meters) at certain points.
//! assert_eq!(segment.points[0].elevation, Some(4.46));
//! assert_eq!(segment.points[1].elevation, Some(4.94));
//! assert_eq!(segment.points[2].elevation, Some(6.87));
//! ```

#[macro_use]
extern crate error_chain;

#[cfg(test)]
#[macro_use]
extern crate assert_approx_eq;

extern crate chrono;
extern crate geo_types;
extern crate xml;

#[cfg(test)]
extern crate geo;

// Export our type structs in the root, along with the read and write functions.
pub use reader::read;
pub use types::*;
pub use writer::write;

mod parser;
mod reader;
mod types;
mod writer;

// Errors should be namespaced away.
pub mod errors;