#[non_exhaustive]pub struct CalculateRoutesInput {Show 25 fields
pub allow: Option<RouteAllowOptions>,
pub arrival_time: Option<String>,
pub avoid: Option<RouteAvoidanceOptions>,
pub depart_now: Option<bool>,
pub departure_time: Option<String>,
pub destination: Option<Vec<f64>>,
pub destination_options: Option<RouteDestinationOptions>,
pub driver: Option<RouteDriverOptions>,
pub exclude: Option<RouteExclusionOptions>,
pub instructions_measurement_system: Option<MeasurementSystem>,
pub key: Option<String>,
pub languages: Option<Vec<String>>,
pub leg_additional_features: Option<Vec<RouteLegAdditionalFeature>>,
pub leg_geometry_format: Option<GeometryFormat>,
pub max_alternatives: Option<i32>,
pub optimize_routing_for: Option<RoutingObjective>,
pub origin: Option<Vec<f64>>,
pub origin_options: Option<RouteOriginOptions>,
pub span_additional_features: Option<Vec<RouteSpanAdditionalFeature>>,
pub tolls: Option<RouteTollOptions>,
pub traffic: Option<RouteTrafficOptions>,
pub travel_mode: Option<RouteTravelMode>,
pub travel_mode_options: Option<RouteTravelModeOptions>,
pub travel_step_type: Option<RouteTravelStepType>,
pub waypoints: Option<Vec<RouteWaypoint>>,
}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<RouteAllowOptions>Features that are allowed while calculating a route.
arrival_time: Option<String>Time of arrival at the destination.
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
avoid: Option<RouteAvoidanceOptions>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
destination: Option<Vec<f64>>The final position for the route. In the World Geodetic System (WGS 84) format: \[longitude, latitude\].
destination_options: Option<RouteDestinationOptions>Destination related options.
driver: Option<RouteDriverOptions>Driver related options.
exclude: Option<RouteExclusionOptions>Features to be strictly excluded while calculating the route.
instructions_measurement_system: Option<MeasurementSystem>Measurement system to be used for instructions within steps in the response.
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.
languages: Option<Vec<String>>List of languages for instructions within steps in the response.
Instructions in the requested language are returned only if they are available.
leg_additional_features: Option<Vec<RouteLegAdditionalFeature>>A list of optional additional parameters such as timezone that can be requested for each result.
-
Elevation: Retrieves the elevation information for each location. -
Incidents: Provides information on traffic incidents along the route. -
PassThroughWaypoints: Indicates waypoints that are passed through without stopping. -
Summary: Returns a summary of the route, including distance and duration. -
Tolls: Supplies toll cost information along the route. -
TravelStepInstructions: Provides step-by-step instructions for travel along the route. -
TruckRoadTypes: Returns information about road types suitable for trucks. -
TypicalDuration: Gives typical travel duration based on historical data. -
Zones: Specifies the time zone information for each waypoint.
leg_geometry_format: Option<GeometryFormat>Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.
FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline .
Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.
max_alternatives: Option<i32>Maximum number of alternative routes to be provided in the response, if available.
optimize_routing_for: Option<RoutingObjective>Specifies the optimization criteria for calculating a route.
Default Value: FastestRoute
origin: Option<Vec<f64>>The start position for the route.
origin_options: Option<RouteOriginOptions>Origin related options.
span_additional_features: Option<Vec<RouteSpanAdditionalFeature>>A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.
tolls: Option<RouteTollOptions>Toll related options.
traffic: Option<RouteTrafficOptions>Traffic related options.
travel_mode: Option<RouteTravelMode>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<RouteTravelModeOptions>Travel mode related options for the provided travel mode.
travel_step_type: Option<RouteTravelStepType>Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.
waypoints: Option<Vec<RouteWaypoint>>List of waypoints between the Origin and Destination.
Implementations§
Source§impl CalculateRoutesInput
impl CalculateRoutesInput
Sourcepub fn allow(&self) -> Option<&RouteAllowOptions>
pub fn allow(&self) -> Option<&RouteAllowOptions>
Features that are allowed while calculating a route.
Sourcepub fn arrival_time(&self) -> Option<&str>
pub fn arrival_time(&self) -> Option<&str>
Time of arrival at the destination.
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 avoid(&self) -> Option<&RouteAvoidanceOptions>
pub fn avoid(&self) -> Option<&RouteAvoidanceOptions>
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 destination(&self) -> &[f64]
pub fn destination(&self) -> &[f64]
The final position for the route. In the World Geodetic System (WGS 84) format: \[longitude, latitude\].
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .destination.is_none().
Sourcepub fn destination_options(&self) -> Option<&RouteDestinationOptions>
pub fn destination_options(&self) -> Option<&RouteDestinationOptions>
Destination related options.
Sourcepub fn driver(&self) -> Option<&RouteDriverOptions>
pub fn driver(&self) -> Option<&RouteDriverOptions>
Driver related options.
Sourcepub fn exclude(&self) -> Option<&RouteExclusionOptions>
pub fn exclude(&self) -> Option<&RouteExclusionOptions>
Features to be strictly excluded while calculating the route.
Sourcepub fn instructions_measurement_system(&self) -> Option<&MeasurementSystem>
pub fn instructions_measurement_system(&self) -> Option<&MeasurementSystem>
Measurement system to be used for instructions within steps in the response.
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 languages(&self) -> &[String]
pub fn languages(&self) -> &[String]
List of languages for instructions within steps in the response.
Instructions in the requested language are returned only if they are available.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .languages.is_none().
Sourcepub fn leg_additional_features(&self) -> &[RouteLegAdditionalFeature]
pub fn leg_additional_features(&self) -> &[RouteLegAdditionalFeature]
A list of optional additional parameters such as timezone that can be requested for each result.
-
Elevation: Retrieves the elevation information for each location. -
Incidents: Provides information on traffic incidents along the route. -
PassThroughWaypoints: Indicates waypoints that are passed through without stopping. -
Summary: Returns a summary of the route, including distance and duration. -
Tolls: Supplies toll cost information along the route. -
TravelStepInstructions: Provides step-by-step instructions for travel along the route. -
TruckRoadTypes: Returns information about road types suitable for trucks. -
TypicalDuration: Gives typical travel duration based on historical data. -
Zones: Specifies the time zone information for each waypoint.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .leg_additional_features.is_none().
Sourcepub fn leg_geometry_format(&self) -> Option<&GeometryFormat>
pub fn leg_geometry_format(&self) -> Option<&GeometryFormat>
Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.
FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline .
Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.
Sourcepub fn max_alternatives(&self) -> Option<i32>
pub fn max_alternatives(&self) -> Option<i32>
Maximum number of alternative routes to be provided in the response, if available.
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 origin(&self) -> &[f64]
pub fn origin(&self) -> &[f64]
The start position for the route.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .origin.is_none().
Sourcepub fn origin_options(&self) -> Option<&RouteOriginOptions>
pub fn origin_options(&self) -> Option<&RouteOriginOptions>
Origin related options.
Sourcepub fn span_additional_features(&self) -> &[RouteSpanAdditionalFeature]
pub fn span_additional_features(&self) -> &[RouteSpanAdditionalFeature]
A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .span_additional_features.is_none().
Sourcepub fn tolls(&self) -> Option<&RouteTollOptions>
pub fn tolls(&self) -> Option<&RouteTollOptions>
Toll related options.
Sourcepub fn traffic(&self) -> Option<&RouteTrafficOptions>
pub fn traffic(&self) -> Option<&RouteTrafficOptions>
Traffic related options.
Sourcepub fn travel_mode(&self) -> Option<&RouteTravelMode>
pub fn travel_mode(&self) -> Option<&RouteTravelMode>
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<&RouteTravelModeOptions>
pub fn travel_mode_options(&self) -> Option<&RouteTravelModeOptions>
Travel mode related options for the provided travel mode.
Sourcepub fn travel_step_type(&self) -> Option<&RouteTravelStepType>
pub fn travel_step_type(&self) -> Option<&RouteTravelStepType>
Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.
Sourcepub fn waypoints(&self) -> &[RouteWaypoint]
pub fn waypoints(&self) -> &[RouteWaypoint]
List of waypoints between the Origin and Destination.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .waypoints.is_none().
Source§impl CalculateRoutesInput
impl CalculateRoutesInput
Sourcepub fn builder() -> CalculateRoutesInputBuilder
pub fn builder() -> CalculateRoutesInputBuilder
Creates a new builder-style object to manufacture CalculateRoutesInput.
Trait Implementations§
Source§impl Clone for CalculateRoutesInput
impl Clone for CalculateRoutesInput
Source§fn clone(&self) -> CalculateRoutesInput
fn clone(&self) -> CalculateRoutesInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CalculateRoutesInput
impl Debug for CalculateRoutesInput
Source§impl PartialEq for CalculateRoutesInput
impl PartialEq for CalculateRoutesInput
impl StructuralPartialEq for CalculateRoutesInput
Auto Trait Implementations§
impl Freeze for CalculateRoutesInput
impl RefUnwindSafe for CalculateRoutesInput
impl Send for CalculateRoutesInput
impl Sync for CalculateRoutesInput
impl Unpin for CalculateRoutesInput
impl UnwindSafe for CalculateRoutesInput
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);