Struct CalculateRouteMatrixOutput

#[non_exhaustive]
pub struct CalculateRouteMatrixOutput {
    pub route_matrix: Vec<Vec<RouteMatrixEntry>>,
    pub snapped_departure_positions: Option<Vec<Vec<f64>>>,
    pub snapped_destination_positions: Option<Vec<Vec<f64>>>,
    pub summary: Option<CalculateRouteMatrixSummary>,
    /* private fields */
}

Returns the result of the route matrix calculation.

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.

route_matrix: Vec<Vec<RouteMatrixEntry>>

The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

snapped_departure_positions: Option<Vec<Vec<f64>>>

For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

snapped_destination_positions: Option<Vec<Vec<f64>>>

The list of destination positions for the route matrix used for calculation of the RouteMatrix.

summary: Option<CalculateRouteMatrixSummary>

Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

Implementations

impl CalculateRouteMatrixOutput

pub fn route_matrix(&self) -> &[Vec<RouteMatrixEntry>]

The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

pub fn snapped_departure_positions(&self) -> &[Vec<f64>]

For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .snapped_departure_positions.is_none().

pub fn snapped_destination_positions(&self) -> &[Vec<f64>]

The list of destination positions for the route matrix used for calculation of the RouteMatrix.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .snapped_destination_positions.is_none().

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

Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

impl CalculateRouteMatrixOutput

pub fn builder() -> CalculateRouteMatrixOutputBuilder

Creates a new builder-style object to manufacture CalculateRouteMatrixOutput.

Trait Implementations

impl Clone for CalculateRouteMatrixOutput

fn clone(&self) -> CalculateRouteMatrixOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CalculateRouteMatrixOutput

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

Formats the value using the given formatter.

impl PartialEq for CalculateRouteMatrixOutput

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

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

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

impl StructuralPartialEq for CalculateRouteMatrixOutput