pub struct CalculateRouteMatrixFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CalculateRouteMatrix
.
Use CalculateRouteMatrix
to compute results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.
Implementations§
Source§impl CalculateRouteMatrixFluentBuilder
impl CalculateRouteMatrixFluentBuilder
Sourcepub fn as_input(&self) -> &CalculateRouteMatrixInputBuilder
pub fn as_input(&self) -> &CalculateRouteMatrixInputBuilder
Access the CalculateRouteMatrix as a reference.
Sourcepub async fn send(
self,
) -> Result<CalculateRouteMatrixOutput, SdkError<CalculateRouteMatrixError, HttpResponse>>
pub async fn send( self, ) -> Result<CalculateRouteMatrixOutput, SdkError<CalculateRouteMatrixError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CalculateRouteMatrixOutput, CalculateRouteMatrixError, Self>
pub fn customize( self, ) -> CustomizableOperation<CalculateRouteMatrixOutput, CalculateRouteMatrixError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn allow(self, input: RouteMatrixAllowOptions) -> Self
pub fn allow(self, input: RouteMatrixAllowOptions) -> Self
Features that are allowed while calculating a route.
Sourcepub fn set_allow(self, input: Option<RouteMatrixAllowOptions>) -> Self
pub fn set_allow(self, input: Option<RouteMatrixAllowOptions>) -> Self
Features that are allowed while calculating a route.
Sourcepub fn get_allow(&self) -> &Option<RouteMatrixAllowOptions>
pub fn get_allow(&self) -> &Option<RouteMatrixAllowOptions>
Features that are allowed while calculating a route.
Sourcepub fn avoid(self, input: RouteMatrixAvoidanceOptions) -> Self
pub fn avoid(self, input: RouteMatrixAvoidanceOptions) -> Self
Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.
Sourcepub fn set_avoid(self, input: Option<RouteMatrixAvoidanceOptions>) -> Self
pub fn set_avoid(self, input: Option<RouteMatrixAvoidanceOptions>) -> Self
Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.
Sourcepub fn get_avoid(&self) -> &Option<RouteMatrixAvoidanceOptions>
pub fn get_avoid(&self) -> &Option<RouteMatrixAvoidanceOptions>
Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.
Sourcepub fn depart_now(self, input: bool) -> Self
pub fn depart_now(self, input: bool) -> Self
Uses the current time as the time of departure.
Sourcepub fn set_depart_now(self, input: Option<bool>) -> Self
pub fn set_depart_now(self, input: Option<bool>) -> Self
Uses the current time as the time of departure.
Sourcepub fn get_depart_now(&self) -> &Option<bool>
pub fn get_depart_now(&self) -> &Option<bool>
Uses the current time as the time of departure.
Sourcepub fn departure_time(self, input: impl Into<String>) -> Self
pub fn departure_time(self, input: impl Into<String>) -> Self
Time of departure from thr origin.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Sourcepub fn set_departure_time(self, input: Option<String>) -> Self
pub fn set_departure_time(self, input: Option<String>) -> Self
Time of departure from thr origin.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Sourcepub fn get_departure_time(&self) -> &Option<String>
pub fn get_departure_time(&self) -> &Option<String>
Time of departure from thr origin.
Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm
Examples:
2020-04-22T17:57:24Z
2020-04-22T17:57:24+02:00
Sourcepub fn destinations(self, input: RouteMatrixDestination) -> Self
pub fn destinations(self, input: RouteMatrixDestination) -> Self
Appends an item to Destinations
.
To override the contents of this collection use set_destinations
.
List of destinations for the route.
Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. See Amazon Location's pricing page for more information.
Sourcepub fn set_destinations(
self,
input: Option<Vec<RouteMatrixDestination>>,
) -> Self
pub fn set_destinations( self, input: Option<Vec<RouteMatrixDestination>>, ) -> Self
List of destinations for the route.
Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. See Amazon Location's pricing page for more information.
Sourcepub fn get_destinations(&self) -> &Option<Vec<RouteMatrixDestination>>
pub fn get_destinations(&self) -> &Option<Vec<RouteMatrixDestination>>
List of destinations for the route.
Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. See Amazon Location's pricing page for more information.
Sourcepub fn exclude(self, input: RouteMatrixExclusionOptions) -> Self
pub fn exclude(self, input: RouteMatrixExclusionOptions) -> Self
Features to be strictly excluded while calculating the route.
Sourcepub fn set_exclude(self, input: Option<RouteMatrixExclusionOptions>) -> Self
pub fn set_exclude(self, input: Option<RouteMatrixExclusionOptions>) -> Self
Features to be strictly excluded while calculating the route.
Sourcepub fn get_exclude(&self) -> &Option<RouteMatrixExclusionOptions>
pub fn get_exclude(&self) -> &Option<RouteMatrixExclusionOptions>
Features to be strictly excluded while calculating the route.
Sourcepub fn key(self, input: impl Into<String>) -> Self
pub fn key(self, input: impl Into<String>) -> Self
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
Sourcepub fn set_key(self, input: Option<String>) -> Self
pub fn set_key(self, input: Option<String>) -> Self
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
Sourcepub fn get_key(&self) -> &Option<String>
pub fn get_key(&self) -> &Option<String>
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
Sourcepub fn optimize_routing_for(self, input: RoutingObjective) -> Self
pub fn optimize_routing_for(self, input: RoutingObjective) -> Self
Specifies the optimization criteria for calculating a route.
Default Value: FastestRoute
Sourcepub fn set_optimize_routing_for(self, input: Option<RoutingObjective>) -> Self
pub fn set_optimize_routing_for(self, input: Option<RoutingObjective>) -> Self
Specifies the optimization criteria for calculating a route.
Default Value: FastestRoute
Sourcepub fn get_optimize_routing_for(&self) -> &Option<RoutingObjective>
pub fn get_optimize_routing_for(&self) -> &Option<RoutingObjective>
Specifies the optimization criteria for calculating a route.
Default Value: FastestRoute
Sourcepub fn origins(self, input: RouteMatrixOrigin) -> Self
pub fn origins(self, input: RouteMatrixOrigin) -> Self
Appends an item to Origins
.
To override the contents of this collection use set_origins
.
The position in longitude and latitude for the origin.
Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. See Amazon Location's pricing page for more information.
Sourcepub fn set_origins(self, input: Option<Vec<RouteMatrixOrigin>>) -> Self
pub fn set_origins(self, input: Option<Vec<RouteMatrixOrigin>>) -> Self
The position in longitude and latitude for the origin.
Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. See Amazon Location's pricing page for more information.
Sourcepub fn get_origins(&self) -> &Option<Vec<RouteMatrixOrigin>>
pub fn get_origins(&self) -> &Option<Vec<RouteMatrixOrigin>>
The position in longitude and latitude for the origin.
Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. See Amazon Location's pricing page for more information.
Sourcepub fn routing_boundary(self, input: RouteMatrixBoundary) -> Self
pub fn routing_boundary(self, input: RouteMatrixBoundary) -> Self
Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.
When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
Sourcepub fn set_routing_boundary(self, input: Option<RouteMatrixBoundary>) -> Self
pub fn set_routing_boundary(self, input: Option<RouteMatrixBoundary>) -> Self
Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.
When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
Sourcepub fn get_routing_boundary(&self) -> &Option<RouteMatrixBoundary>
pub fn get_routing_boundary(&self) -> &Option<RouteMatrixBoundary>
Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.
When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
Sourcepub fn traffic(self, input: RouteMatrixTrafficOptions) -> Self
pub fn traffic(self, input: RouteMatrixTrafficOptions) -> Self
Traffic related options.
Sourcepub fn set_traffic(self, input: Option<RouteMatrixTrafficOptions>) -> Self
pub fn set_traffic(self, input: Option<RouteMatrixTrafficOptions>) -> Self
Traffic related options.
Sourcepub fn get_traffic(&self) -> &Option<RouteMatrixTrafficOptions>
pub fn get_traffic(&self) -> &Option<RouteMatrixTrafficOptions>
Traffic related options.
Sourcepub fn travel_mode(self, input: RouteMatrixTravelMode) -> Self
pub fn travel_mode(self, input: RouteMatrixTravelMode) -> Self
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default Value: Car
Sourcepub fn set_travel_mode(self, input: Option<RouteMatrixTravelMode>) -> Self
pub fn set_travel_mode(self, input: Option<RouteMatrixTravelMode>) -> Self
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default Value: Car
Sourcepub fn get_travel_mode(&self) -> &Option<RouteMatrixTravelMode>
pub fn get_travel_mode(&self) -> &Option<RouteMatrixTravelMode>
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default Value: Car
Sourcepub fn travel_mode_options(self, input: RouteMatrixTravelModeOptions) -> Self
pub fn travel_mode_options(self, input: RouteMatrixTravelModeOptions) -> Self
Travel mode related options for the provided travel mode.
Sourcepub fn set_travel_mode_options(
self,
input: Option<RouteMatrixTravelModeOptions>,
) -> Self
pub fn set_travel_mode_options( self, input: Option<RouteMatrixTravelModeOptions>, ) -> Self
Travel mode related options for the provided travel mode.
Sourcepub fn get_travel_mode_options(&self) -> &Option<RouteMatrixTravelModeOptions>
pub fn get_travel_mode_options(&self) -> &Option<RouteMatrixTravelModeOptions>
Travel mode related options for the provided travel mode.
Trait Implementations§
Source§impl Clone for CalculateRouteMatrixFluentBuilder
impl Clone for CalculateRouteMatrixFluentBuilder
Source§fn clone(&self) -> CalculateRouteMatrixFluentBuilder
fn clone(&self) -> CalculateRouteMatrixFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CalculateRouteMatrixFluentBuilder
impl !RefUnwindSafe for CalculateRouteMatrixFluentBuilder
impl Send for CalculateRouteMatrixFluentBuilder
impl Sync for CalculateRouteMatrixFluentBuilder
impl Unpin for CalculateRouteMatrixFluentBuilder
impl !UnwindSafe for CalculateRouteMatrixFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);