Struct google_maps::roads::nearest_roads::request::Request

pub struct Request<'a> { /* private fields */ }

Look at this Request struct for documentation on how to build your Snap To Roads query. The methods implemented for this struct are what’s used to build your request.

Implementations

impl<'a> Request<'a>

pub fn build(&mut self) -> &'a mut Request<'_>

Builds the query string for the Google Maps Nearest Roads request based on the input provided by the client.

Arguments

This method accepts no arguments.

impl<'a> Request<'a>

pub async fn execute( &'a mut self ) -> Result<NearestRoadsResponse, GoogleMapsError>

Executes the query you’ve built.

Description

My adventures in Rust became messy so I had to make this method. It wraps the .validate()?.build()?.get()? chain needed at the end of the builder pattern.

Arguments

This method accepts no arguments.

impl<'a> Request<'a>

pub async fn get(&mut self) -> Result<NearestRoadsResponse, GoogleMapsError>

Performs the HTTP get request and returns the response to the caller.

Arguments

This method accepts no arguments.

impl<'a> Request<'a>

pub fn new(client: &GoogleMapsClient, points: Vec<LatLng>) -> Request<'_>

Initializes the builder pattern for a Nearest Roads query with the required parameters.

Note: The snapping algorithm works best for points that are not too far apart. If you observe odd snapping behavior, try creating paths that have points closer together. To ensure the best snap-to-road quality, you should aim to provide paths on which consecutive pairs of points are within 300m of each other. This will also help in handling any isolated, long jumps between consecutive points caused by GPS signal loss, or noise.

Arguments

• client ‧ Your application’s Google Maps API client struct.

• points ‧ The points to be snapped. The points parameter accepts a list of latitude/longitude pairs.

impl<'a> Request<'a>

pub fn query_url(&'a mut self) -> String

Returns the URL query string that represents the query you’ve built.

Description

Returns the query string that will be sent to the Google Maps API. It is the result of the builder pattern. This method could be useful for records or logging. It could also be used for passing to your HTTP client of choice and executing the HTTP GET request yourself.

Arguments

This method accepts no arguments.

Trait Implementations

impl<'a> Debug for Request<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.