[][src]Crate google_maps

google_maps

An unofficial Google Maps Platform client for the Rust programming language. This client currently implements the Directions API, Elevation API, Geocoding API, and Time Zone API.

Welcome

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 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.

Example Directions API Request

use google_maps::*;

let directions = DirectionsRequest::new(
    YOUR_GOOGLE_API_KEY_HERE,
    // Canadian Museum of Nature
    Location::Address(String::from("240 McLeod St, Ottawa, ON K2P 2R1")),
    // Canada Science and Technology Museum
    Location::LatLng { lat: 45.403509, lng: -75.618904 },
)
.with_travel_mode(TravelMode::Transit)
.with_arrival_time(PrimitiveDateTime::new(
    Date::try_from_ymd(2020, 1, 20).unwrap(),
    Time::try_from_hms(13, 00, 0).unwrap()
))
.execute().unwrap();

println!("{:#?}", directions);

Example Elevation API Positional Request

use google_maps::*;

let elevation = ElevationRequest::new(YOUR_GOOGLE_API_KEY_HERE)
.positional_request(ElevationLocations::LatLngs(vec![
    // Denver, Colorado, the "Mile High City"
    LatLng { lat: 39.7391536, lng: -104.9847034 },
]))
.execute().unwrap();

println!("{:#?}", elevation);

Example Forward Geocoding API Request

use google_maps::*;

let location = GeocodingRequest::new(YOUR_GOOGLE_API_KEY_HERE)
.with_address("10 Downing Street London")
.execute().unwrap();

println!("{:#?}", location);

Example Reverse Geocoding API Request

use google_maps::*;

let location = GeocodingReverseRequest::new(
    YOUR_GOOGLE_API_KEY_HERE,
    // Denver, Colorado, the "Mile High City"
    LatLng { lat: 39.7391536, lng: -104.9847034 }
)
.with_result_type(PlaceType::Locality)
.execute().unwrap();

println!("{:#?}", location);

Example Time Zone API Request

use google_maps::*;

let time_zone = TimeZoneRequest::new(
    YOUR_GOOGLE_API_KEY_HERE,
    // St. Vitus Cathedral in Prague, Czechia
    LatLng { lat: 50.090903, lng: 14.400512 },
    PrimitiveDateTime::new(
        // Tuesday February 15, 2022
        Date::try_from_ymd(2022, 2, 15).unwrap(),
        // 6:00:00 pm
        Time::try_from_hms(18, 00, 0).unwrap(),
    ),
).execute().unwrap();

println!("{:#?}", time_zone);

To do:

  1. Distance Matrix API
  2. Geolocation API
  3. Places API
  4. Roads API
  5. Automatic Rate Limiting
  6. Retry on Failure

Re-exports

pub extern crate time;
pub use crate::bounds::Bounds;
pub use crate::language::Language;
pub use crate::latlng::LatLng;
pub use crate::place_type::PlaceType;
pub use crate::region::Region;
pub use crate::directions::request::avoid::Avoid;
pub use crate::directions::request::departure_time::DepartureTime;
pub use crate::directions::request::location::Location;
pub use crate::directions::request::Request as DirectionsRequest;
pub use crate::directions::request::traffic_model::TrafficModel;
pub use crate::directions::request::transit_mode::TransitMode;
pub use crate::directions::request::transit_route_preference::TransitRoutePreference;
pub use crate::directions::request::unit_system::UnitSystem;
pub use crate::directions::request::waypoint::Waypoint;
pub use crate::directions::response::Response as Directions;
pub use crate::directions::response::status::Status as DirectionsStatus;
pub use crate::directions::travel_mode::TravelMode;
pub use crate::elevation::error::Error as ElevationError;
pub use crate::elevation::request::locations::Locations as ElevationLocations;
pub use crate::elevation::request::Request as ElevationRequest;
pub use crate::elevation::response::Response as Elevation;
pub use crate::elevation::response::status::Status as ElevationStatus;
pub use crate::geocoding::error::Error as GeocodingError;
pub use crate::geocoding::forward::component::Component as GeocodingComponent;
pub use crate::geocoding::forward::ForwardRequest as GeocodingForwardRequest;
pub use crate::geocoding::forward::ForwardRequest as GeocodingRequest;
pub use crate::geocoding::location_type::LocationType;
pub use crate::geocoding::response::Response as Geocoding;
pub use crate::geocoding::response::status::Status as GeocodingStatus;
pub use crate::geocoding::reverse::ReverseRequest as GeocodingReverseRequest;
pub use crate::time_zone::error::Error as TimeZoneError;
pub use crate::time_zone::request::Request as TimeZoneRequest;
pub use crate::time_zone::response::Response as TimeZone;
pub use crate::time_zone::response::status::Status as TimeZoneStatus;

Modules

bounds
directions

The Directions API is a service that calculates directions between locations. You can search for directions for several modes of transportation, including transit, driving, walking, or cycling.

elevation

The Elevation API provides elevation data for all locations on the surface of the earth, including depth locations on the ocean floor (which return negative values).

geocoding

The Geocoding API is a service that provides geocoding and reverse geocoding of addresses.

language
latlng
place_type
region
time_zone

The Time Zone API provides time offset data for locations on the surface of the earth. You request the time zone information for a specific latitude/longitude pair and date. The API returns the name of that time zone, the time offset from UTC, and the daylight savings offset.

Structs

Date

Calendar date.

PrimitiveDateTime

Combined date and time.

Time

The clock time within a given date. Nanosecond precision.