Struct CalculateRouteOutput 

#[non_exhaustive]
pub struct CalculateRouteOutput {
    pub legs: Vec<Leg>,
    pub summary: Option<CalculateRouteSummary>,
    /* private fields */
}

Returns the result of the route calculation. Metadata includes legs and route summary.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

legs: Vec<Leg>

Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

• The StartPosition is the departure position.

• The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

• Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.

• Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

summary: Option<CalculateRouteSummary>

Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

Implementations

impl CalculateRouteOutput

pub fn legs(&self) -> &[Leg]

Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

• The StartPosition is the departure position.

• The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

• Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.

• Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

pub fn summary(&self) -> Option<&CalculateRouteSummary>

Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

impl CalculateRouteOutput

pub fn builder() -> CalculateRouteOutputBuilder

Creates a new builder-style object to manufacture CalculateRouteOutput.

Trait Implementations

impl Clone for CalculateRouteOutput

fn clone(&self) -> CalculateRouteOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CalculateRouteOutput

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

Formats the value using the given formatter.

impl PartialEq for CalculateRouteOutput

fn eq(&self, other: &CalculateRouteOutput) -> 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 RequestId for CalculateRouteOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for CalculateRouteOutput