1- //! GPX track/route and waypoint reader
2- //!
3- //! # Usage
4- //!
5- //! Provides an iterator that reads in sequence the trackpoints/routepoints,
6- //! waypoints, and other relevant items from a GPX track file.
7- //!
8- //! This module treats GPX routes and tracks synonymously, except that tracks
9- //! may also contain segments.
10- //!
11- //! To use module, instantiate a [`GpxReader`] by calling
12- //! [`GpxReader::from_text`] or [`GpxReader::from_reader`]. Iterating over the
13- //! [`GpxReader`] will produce a sequence of [`GpxItem`] describing the
14- //! contents of the input.
1+ /*!
2+ GPX track/route and waypoint reader
3+
4+ # Usage
5+
6+ Provides an iterator that reads in sequence the trackpoints/routepoints,
7+ waypoints, and other relevant items from a GPX track file.
8+
9+ This module treats GPX routes and tracks synonymously, except that tracks may
10+ also contain segments.
11+
12+ To use module, instantiate a [`GpxReader`] by calling
13+ [`GpxReader::from_text`] or [`GpxReader::from_reader`]. Iterating over the
14+ [`GpxReader`] will produce a sequence of [`GpxItem`] describing the
15+ contents of the input.
16+ */
1517
1618use std:: io:: BufRead ;
1719use std:: num:: ParseFloatError ;
@@ -20,8 +22,8 @@ use std::{mem, str};
2022use coretypes:: measure:: { Degrees , Meters } ;
2123use coretypes:: { GeoPoint , TypeError } ;
2224use quick_xml;
23- use quick_xml:: events:: attributes:: AttrError ;
2425use quick_xml:: events:: Event ;
26+ use quick_xml:: events:: attributes:: AttrError ;
2527use quick_xml:: name:: QName ;
2628use quick_xml:: reader:: Reader ;
2729use thiserror:: Error ;
@@ -352,7 +354,7 @@ where
352354#[ cfg( test) ]
353355mod tests {
354356 use coretypes:: measure:: { Degrees , Meters } ;
355- use coretypes:: { geo_points , GeoPoint } ;
357+ use coretypes:: { GeoPoint , geo_points } ;
356358
357359 use super :: { GpxError , GpxItem , GpxReader , Result , Waypoint } ;
358360
0 commit comments