add a complete example on stops handling

Author: antoine-de

examples/gtfs_reader.rs

@@ -2,8 +2,8 @@ fn main() {
     /* Gtfs::new will try to guess if you provide a path, a local zip file or a remote zip file.
        You can also use Gtfs::from_path, Gtfs::from_url
     */
-    let gtfs = gtfs_structures::GtfsReader::default()
-        .read_stop_times(false)
+    let mut gtfs = gtfs_structures::GtfsReader::default()
+        .read_stop_times(true)
         .read("fixtures/basic")
         .expect("impossible to read gtfs");
     gtfs.print_stats();
@@ -12,4 +12,33 @@ fn main() {
 
     let route_1 = gtfs.routes.get("1").expect("no route 1");
     println!("{}: {:?}", route_1.short_name, route_1);
+
+    // you can access a stop by a &str
+    let _ = gtfs
+        .get_stop_by_raw_id("stop1")
+        .expect("unable to find stop Stop Area");
+
+    let trip = gtfs.trips.get("trip1").expect("no route 1");
+    let stop_id: &gtfs_structures::Id<gtfs_structures::Stop> =
+        &trip.stop_times.first().expect("no stoptimes").stop;
+
+    // or with a typed id if you have one
+
+    // if no stops have been removed from the gtfs, you can safely access the stops by it's id
+    let s = &gtfs.stops[stop_id];
+    println!("stop name: {}", &s.name);
+
+    // if some removal have been done, you can also you those method to get an Option<Stop>
+    let s = gtfs.get_stop(stop_id).expect("this stop should exists");
+    println!("stop description: {}", &s.description);
+
+    // or you can access it via `stops.get`
+    let s = gtfs.stops.get(stop_id).expect("this stop should exists");
+    println!("stop location type: {:?}", &s.location_type);
+
+    let mut s = gtfs
+        .stops
+        .get_mut(stop_id)
+        .expect("this stop should exists");
+    s.code = Some("code".into());
 }

fixtures/basic/stops.txt

@@ -1,6 +1,6 @@
 stop_id,stop_name,stop_desc,stop_lat,stop_lon,zone_id,stop_url,location_type,parent_station,wheelchair_boarding
 stop1,"Stop Area",, 48.796058 ,2.449386,,,1,,
-stop2,"StopPoint",,48.796058,2.449386,,,,,
+stop2,"StopPoint",some description,48.796058,2.449386,,,,,
 stop3,"Stop Point child of 1",,48.796058,2.449386,,,0,1,
 stop4,"StopPoint2",,48.796058,2.449386,,,,,
 stop5,"Stop Point child of 1 bis",,48.796058,2.449386,,,0,1,