Struct CalculateRouteSummaryBuilder 

#[non_exhaustive]
pub struct CalculateRouteSummaryBuilder { /* private fields */ }

A builder for CalculateRouteSummary.

Implementations

impl CalculateRouteSummaryBuilder

pub fn route_b_box(self, input: f64) -> Self

Appends an item to route_b_box.

To override the contents of this collection use set_route_b_box.

Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, \[min x, min y, max x, max y\].

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

The next 2 bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.

pub fn set_route_b_box(self, input: Option<Vec<f64>>) -> Self

Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, \[min x, min y, max x, max y\].

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

The next 2 bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.

pub fn get_route_b_box(&self) -> &Option<Vec<f64>>

Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, \[min x, min y, max x, max y\].

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

The next 2 bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.

pub fn data_source(self, input: impl Into<String>) -> Self

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

• Esri

• Grab

• Here

For more information about data providers, see Amazon Location Service data providers.

This field is required.

pub fn set_data_source(self, input: Option<String>) -> Self

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

• Esri

• Grab

• Here

For more information about data providers, see Amazon Location Service data providers.

pub fn get_data_source(&self) -> &Option<String>

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

• Esri

• Grab

• Here

For more information about data providers, see Amazon Location Service data providers.

pub fn distance(self, input: f64) -> Self

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.

This field is required.

pub fn set_distance(self, input: Option<f64>) -> Self

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.

pub fn get_distance(&self) -> &Option<f64>

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.

pub fn duration_seconds(self, input: f64) -> Self

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

This field is required.

pub fn set_duration_seconds(self, input: Option<f64>) -> Self

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

pub fn get_duration_seconds(&self) -> &Option<f64>

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

pub fn distance_unit(self, input: DistanceUnit) -> Self

The unit of measurement for route distances.

This field is required.

pub fn set_distance_unit(self, input: Option<DistanceUnit>) -> Self

The unit of measurement for route distances.

pub fn get_distance_unit(&self) -> &Option<DistanceUnit>

The unit of measurement for route distances.

pub fn build(self) -> Result<CalculateRouteSummary, BuildError>

Consumes the builder and constructs a CalculateRouteSummary. This method will fail if any of the following fields are not set:

• route_b_box
• data_source
• distance
• duration_seconds
• distance_unit

Trait Implementations

impl Clone for CalculateRouteSummaryBuilder

fn clone(&self) -> CalculateRouteSummaryBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CalculateRouteSummaryBuilder

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

Formats the value using the given formatter.

impl Default for CalculateRouteSummaryBuilder

fn default() -> CalculateRouteSummaryBuilder

Returns the “default value” for a type.

impl PartialEq for CalculateRouteSummaryBuilder

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