🗺 An unofficial Google Maps Platform client library for the Rust programming language. This client currently implements the Directions API, Distance Matrix API, Elevation API, Geocoding API, and Time Zone API.
This crate is expected to work well and have the more important Google Maps features implemented. It should work well because Reqwest and Serde do most of the heavy lifting! While it's an early release, this crate should work fine as is for most people.
I created this client library because I needed several Google Maps Platform features for a project that I'm working on. So, I've decided to spin my library off into a public crate. This is a very small token of gratitude and an attempt to give back to the Rust community. I hope it saves someone out there some work.
In your project's Cargo.toml file, under the [dependencies] section:
The full documentation is available at docs.rs
1.0.0: 2020-05-16: Inteface stable.
0.7.3: 2020-04-25: For the Distance-Matrix API, some response fields that should have been public weren't. Fixed.
0.7.2: 2020-04-21: Small bug fixes. Also, some logging was causing stack overflows, so it had to be disabled.
0.7.1: 2020-03-10: Added in as many derivable traits as possible. Changed
transit fare amount from f64 to rust_decimal::Decimal. Clean-ups as
commanded by Clippy.
0.7.1: 2020-03-10: For Time Zone API requests from this crate has moved from
expressing the time in chrono::NaiveDateTime to chrono::DateTime<Utc>. See
the updated time zone example.
0.7.0: 2020-03-08: Transitioned from f64 to rust_decimal::Decimal for
latitude and longitude coordinates. This eliminates rounding errors. The
Decimal type is also hashable. Nice. LatLng, Waypoint, Location types
can now be used as keys for hash maps. To define a Decimal value in your
code, currently you must add the rust_decimal dependency into your
Cargo.toml file. Use the dec!() macro like so: dec!(12.345). This is the
preferred way to define latitude and longitude coordinates. If you do not want
to add this line to your Cargo.toml file, you may also create a Decimal from
a &str like so: Decimal::from_str("12.345").unwrap(). See the new examples.
Also, see the rust_decimal crate for
more information.
0.7.0: 2020-03-08: To better align this crate with Rust conventions, I've
converted many String parameters to &str parameters. If you're receiving new
compilations errors like the trait bound google_maps::directions::response::
driving_maneuver::DrivingManeuver: std::convert::From<std::string::String> is
not satisfied you will have to change your code to borrow the string. For
example, change TransitCurrency::try_from(currency) to
TransitCurrency::try_from(¤cy) or to
TransitCurrency::try_from(&*currency) if its a String type.
0.6.0: 2020-02-29: Cleaned up the mod and use declarations. To glob import
everything from google_maps into your project, you can use the
use google_maps::prelude::* convention now.
The full change log is available on GitHub.
```rust use googlemaps::prelude::*; let mut googlemapsclient = ClientSettings::new(YOURGOOGLEAPIKEY_HERE);
// Example request:
let directions = googlemapsclient.directions( // Origin: Canadian Museum of Nature Location::Address(String::from("240 McLeod St, Ottawa, ON K2P 2R1")), // Destination: Canada Science and Technology Museum Location::LatLng(LatLng::tryfrom(dec!(45.403509), dec!(-75.618904)).unwrap()), ) .withtravelmode(TravelMode::Transit) // Ensure this date is a weekday in the future or this query will return zero // results. .witharrivaltime(NaiveDate::fromymd(2020, 3, 2).and_hms(13, 00, 0)) .execute();
// Dump entire response:
println!("{:#?}", directions); ```
```rust use googlemaps::prelude::*; let mut googlemapsclient = ClientSettings::new(YOURGOOGLEAPIKEY_HERE);
// Example request:
let distancematrix = googlemapsclient.distancematrix( // Origins vec![ // Microsoft Waypoint::Address(String::from("One Microsoft Way, Redmond, WA 98052, United States")), // Cloudflare Waypoint::Address(String::from("101 Townsend St, San Francisco, CA 94107, United States")), ], // Destinations vec![ // Google Waypoint::PlaceId(String::from("ChIJj61dQgK6j4AR4GeTYWZsKWw")), // Mozilla Waypoint::LatLng(LatLng::tryfrom(dec!(37.387316), dec!(-122.060_008)).unwrap()), ], ) .execute();
// Dump entire response:
println!("{:#?}", distance_matrix); ```
```rust use googlemaps::prelude::*; let mut googlemapsclient = ClientSettings::new(YOURGOOGLEAPIKEY_HERE);
// Example request:
let elevation = googlemapsclient.elevation() // Denver, Colorado, the "Mile High City" .forpositionalrequest(&LatLng::tryfrom(dec!(39.739154), dec!(-104.984_703)).unwrap()) .execute();
// Dump entire response:
println!("{:#?}", elevation);
// Parsing example:
println!("Elevation: {} meters", elevation.unwrap().results.unwrap()[0].elevation); ```
```rust use googlemaps::prelude::*; let mut googlemapsclient = ClientSettings::new(YOURGOOGLEAPIKEY_HERE);
// Example request:
let location = googlemapsclient.geocoding() .with_address("10 Downing Street London") .execute();
// Dump entire response:
println!("{:#?}", location);
// Parsing example:
for result in &location.unwrap().results { println!("{}", result.geometry.location) } ```
```rust use googlemaps::prelude::*; let mut googlemapsclient = ClientSettings::new(YOURGOOGLEAPIKEY_HERE);
// Example request:
let location = googlemapsclient.reversegeocoding( // 10 Downing St, Westminster, London LatLng::tryfrom(dec!(51.503364), dec!(-0.127625)).unwrap(), ) .withresulttype(PlaceType::StreetAddress) .execute();
// Dump entire response:
println!("{:#?}", location);
// Parsing example:
for result in &location.unwrap().results { for addresscomponent in &result.addresscomponents { print!("{} ", addresscomponent.shortname); } println!(""); // New line. } ```
```rust use googlemaps::prelude::*; let mut googlemapsclient = ClientSettings::new(YOURGOOGLEAPIKEY_HERE);
// Example request:
let timezone = googlemapsclient.timezone( // St. Vitus Cathedral in Prague, Czechia LatLng::tryfrom(dec!(50.090903), dec!(14.400_512)).unwrap(), // The time right now in UTC (Coordinated Universal Time) Utc::now() ).execute().unwrap();
// Dump entire response:
println!("{:#?}", time_zone);
// Parsing example:
println!("Time at your computer: {}", Local::now().timestamp());
println!("Time in {}: {}", timezone.timezoneid.unwrap().name(), Utc::now().timestamp() + timezone.dstoffset.unwrap() as i64 + timezone.raw_offset.unwrap() as i64 ); ```
The Google Maps client settings can be used to change the request rate and automatic retry parameters.
```rust use google_maps::prelude::*; use std::time::Duration;
let mut googlemapsclient = ClientSettings::new(YOURGOOGLEAPIKEYHERE)
// For all Google Maps Platform APIs, the client will limit 2 sucessful
// requests for every 10 seconds:
.withrate(Api::All, 2, Duration::fromsecs(10))
// For unsuccessful request attempts, the client will attempt 10 retries
// before giving up:
.withmaxretries(10)
// For unsuccessful requests, the delay between retries is increased after
// each attempt. This parameter ensures that the client will not delay for
// more than 32 seconds between retries:
.withmaxdelay(Duration::from_secs(32))
// Returns the ClientSettings struct to the caller. This struct is used to
// make Google Maps Platform requests.
.finalize();
```
Google's Geolocation API seems to be offline. While the online documentation
is still available and the API appears configurable through the Google Cloud
Platform console, the Geolocation API responds Status code 404 Not Found with
an empty body to all requests. This API cannot be implemented until the server
responds as expected.
I would like for you to be successful with your project! If this crate is not working for you, doesn't work how you think it should, or if you have requests, or suggestions - please report them to me! I'm not always fast at responding but I will respond. Thanks!
reqwest to a lighter-weight HTTP client.