Enum Waypoint

pub enum Waypoint {
    Address(String),
    LatLng(LatLng),
    PlaceId(String),
    Polyline(String),
}

Used to specify pass throughs or stopovers at intermediate locations.

Variants

Address(String)

If you pass an address, the Directions service geocodes the string and converts it to latitude & longitude coordinates to calculate directions. This coordinate may be different from that returned by the Geocoding API, for example a building entrance rather than its center.

LatLng(LatLng)

If you pass coordinates, they are used unchanged to calculate directions.

PlaceId(String)

The place ID may only be specified if the request includes an API key or a Google Maps Platform Premium Plan client ID. You can retrieve place IDs from the Geocoding API and the Places API (including Place Autocomplete). For an example using place IDs from Place Autocomplete, see Place Autocomplete and Directions. For more about place IDs, see the Place ID overview.

Polyline(String)

Alternatively, you can supply an encoded set of points using the Encoded Polyline Algorithm. You will find an encoded set is useful for a large number of waypoints, because the URL is significantly shorter. All web services have a URL limit of 8192 characters.

See also: the Google Encoded Polyline encoding & decoding crate called polyline.

Implementations

impl Waypoint

pub fn from_address(address: impl Into<String>) -> Self

If you pass an address, the Directions service geocodes the string and converts it to latitude & longitude coordinates to calculate directions. This coordinate may be different from that returned by the Geocoding API, for example a building entrance rather than its center.

impl Waypoint

pub fn from_place_id(place_id: impl Into<String>) -> Self

The place ID may only be specified if the request includes an API key or a Google Maps Platform Premium Plan client ID. You can retrieve place IDs from the Geocoding API and the Places API (including Place Autocomplete). For an example using place IDs from Place Autocomplete, see Place Autocomplete and Directions. For more about place IDs, see the Place ID overview.

impl Waypoint

pub fn from_polyline(polyline: impl Into<String>) -> Self

Alternatively, you can supply an encoded set of points using the Encoded Polyline Algorithm. You will find an encoded set is useful for a large number of waypoints, because the URL is significantly shorter. All web services have a URL limit of 8192 characters.

See also: the Google Encoded Polyline encoding & decoding crate called polyline.

impl Waypoint

pub fn try_from_dec( latitude: Decimal, longitude: Decimal, ) -> Result<Self, GoogleMapsError>

Takes individual latitude & longitude Decimal coordinates and converts them into a Waypoint structure. If either the latitude (-90.0 to +90.0) or longitude (-180.0 to +180.0) are out of range, this function will return an error.

impl Waypoint

pub fn try_from_f32( latitude: f32, longitude: f32, ) -> Result<Self, GoogleMapsError>

Takes individual latitude & longitude f32 coordinates and converts them into a Waypoint structure. If either the latitude (-90.0 to +90.0) or longitude (-180.0 to +180.0) are out of range, this function will return an error.

impl Waypoint

pub fn try_from_f64( latitude: f64, longitude: f64, ) -> Result<Self, GoogleMapsError>

Takes individual latitude & longitude f64 coordinates and converts them into a Waypoint structure. If either the latitude (-90.0 to +90.0) or longitude (-180.0 to +180.0) are out of range, this function will return an error.

Trait Implementations

impl Clone for Waypoint

fn clone(&self) -> Waypoint

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Waypoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Waypoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&LatLng> for Waypoint

fn from(latlng: &LatLng) -> Self

Converts a borrowed &LatLng coordinates type into a Waypoint type.

impl From<&Waypoint> for String

fn from(waypoint: &Waypoint) -> Self

Converts a Waypoint enum to a String that contains a waypoint value.

impl From<&Waypoint> for Waypoint

fn from(waypoint: &Self) -> Self

Converts a borrowed &Waypoint enum into an owned Waypoint enum by cloning it.

impl From<LatLng> for Waypoint

fn from(latlng: LatLng) -> Self

Converts an owned LatLng coordinates type into a Waypoint type.

impl Hash for Waypoint

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Waypoint

fn cmp(&self, other: &Waypoint) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Waypoint

fn eq(&self, other: &Waypoint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Waypoint

fn partial_cmp(&self, other: &Waypoint) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Waypoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Waypoint

impl StructuralPartialEq for Waypoint