#[non_exhaustive]pub struct CalculateRouteMatrixInput {Show 13 fields
pub allow: Option<RouteMatrixAllowOptions>,
pub avoid: Option<RouteMatrixAvoidanceOptions>,
pub depart_now: Option<bool>,
pub departure_time: Option<String>,
pub destinations: Option<Vec<RouteMatrixDestination>>,
pub exclude: Option<RouteMatrixExclusionOptions>,
pub key: Option<String>,
pub optimize_routing_for: Option<RoutingObjective>,
pub origins: Option<Vec<RouteMatrixOrigin>>,
pub routing_boundary: Option<RouteMatrixBoundary>,
pub traffic: Option<RouteMatrixTrafficOptions>,
pub travel_mode: Option<RouteMatrixTravelMode>,
pub travel_mode_options: Option<RouteMatrixTravelModeOptions>,
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.allow: Option<RouteMatrixAllowOptions>Features that are allowed while calculating a route.
avoid: 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.
depart_now: Option<bool>Uses the current time as the time of departure.
departure_time: 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
destinations: 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.
exclude: Option<RouteMatrixExclusionOptions>Features to be strictly excluded while calculating the route.
key: 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.
optimize_routing_for: Option<RoutingObjective>Specifies the optimization criteria for calculating a route.
Default Value: FastestRoute
origins: 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.
routing_boundary: 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.
traffic: Option<RouteMatrixTrafficOptions>Traffic related options.
travel_mode: Option<RouteMatrixTravelMode>Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default Value: Car
travel_mode_options: Option<RouteMatrixTravelModeOptions>Travel mode related options for the provided travel mode.
Implementations§
Source§impl CalculateRouteMatrixInput
impl CalculateRouteMatrixInput
Sourcepub fn allow(&self) -> Option<&RouteMatrixAllowOptions>
pub fn allow(&self) -> Option<&RouteMatrixAllowOptions>
Features that are allowed while calculating a route.
Sourcepub fn avoid(&self) -> Option<&RouteMatrixAvoidanceOptions>
pub fn 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) -> Option<bool>
pub fn depart_now(&self) -> Option<bool>
Uses the current time as the time of departure.
Sourcepub fn departure_time(&self) -> Option<&str>
pub fn departure_time(&self) -> Option<&str>
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) -> &[RouteMatrixDestination]
pub fn destinations(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .destinations.is_none().
Sourcepub fn exclude(&self) -> Option<&RouteMatrixExclusionOptions>
pub fn exclude(&self) -> Option<&RouteMatrixExclusionOptions>
Features to be strictly excluded while calculating the route.
Sourcepub fn key(&self) -> Option<&str>
pub fn key(&self) -> Option<&str>
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) -> Option<&RoutingObjective>
pub fn optimize_routing_for(&self) -> Option<&RoutingObjective>
Specifies the optimization criteria for calculating a route.
Default Value: FastestRoute
Sourcepub fn origins(&self) -> &[RouteMatrixOrigin]
pub fn origins(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .origins.is_none().
Sourcepub fn routing_boundary(&self) -> Option<&RouteMatrixBoundary>
pub fn 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) -> Option<&RouteMatrixTrafficOptions>
pub fn traffic(&self) -> Option<&RouteMatrixTrafficOptions>
Traffic related options.
Sourcepub fn travel_mode(&self) -> Option<&RouteMatrixTravelMode>
pub fn 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) -> Option<&RouteMatrixTravelModeOptions>
pub fn travel_mode_options(&self) -> Option<&RouteMatrixTravelModeOptions>
Travel mode related options for the provided travel mode.
Source§impl CalculateRouteMatrixInput
impl CalculateRouteMatrixInput
Sourcepub fn builder() -> CalculateRouteMatrixInputBuilder
pub fn builder() -> CalculateRouteMatrixInputBuilder
Creates a new builder-style object to manufacture CalculateRouteMatrixInput.
Trait Implementations§
Source§impl Clone for CalculateRouteMatrixInput
impl Clone for CalculateRouteMatrixInput
Source§fn clone(&self) -> CalculateRouteMatrixInput
fn clone(&self) -> CalculateRouteMatrixInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CalculateRouteMatrixInput
impl Debug for CalculateRouteMatrixInput
impl StructuralPartialEq for CalculateRouteMatrixInput
Auto Trait Implementations§
impl Freeze for CalculateRouteMatrixInput
impl RefUnwindSafe for CalculateRouteMatrixInput
impl Send for CalculateRouteMatrixInput
impl Sync for CalculateRouteMatrixInput
impl Unpin for CalculateRouteMatrixInput
impl UnwindSafe for CalculateRouteMatrixInput
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);