#[non_exhaustive]pub struct CalculateRouteSummary {
pub route_b_box: Vec<f64>,
pub data_source: String,
pub distance: f64,
pub duration_seconds: f64,
pub distance_unit: DistanceUnit,
}
Expand description
A summary of the calculated route.
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.route_b_box: 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.
data_source: 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.
distance: 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.
duration_seconds: f64
The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
distance_unit: DistanceUnit
The unit of measurement for route distances.
Implementations§
Source§impl CalculateRouteSummary
impl CalculateRouteSummary
Sourcepub fn route_b_box(&self) -> &[f64]
pub fn route_b_box(&self) -> &[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.
Sourcepub fn data_source(&self) -> &str
pub fn data_source(&self) -> &str
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.
Sourcepub fn distance(&self) -> f64
pub fn distance(&self) -> 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.
Sourcepub fn duration_seconds(&self) -> f64
pub fn duration_seconds(&self) -> f64
The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
Sourcepub fn distance_unit(&self) -> &DistanceUnit
pub fn distance_unit(&self) -> &DistanceUnit
The unit of measurement for route distances.
Source§impl CalculateRouteSummary
impl CalculateRouteSummary
Sourcepub fn builder() -> CalculateRouteSummaryBuilder
pub fn builder() -> CalculateRouteSummaryBuilder
Creates a new builder-style object to manufacture CalculateRouteSummary
.
Trait Implementations§
Source§impl Clone for CalculateRouteSummary
impl Clone for CalculateRouteSummary
Source§fn clone(&self) -> CalculateRouteSummary
fn clone(&self) -> CalculateRouteSummary
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CalculateRouteSummary
impl Debug for CalculateRouteSummary
Source§impl PartialEq for CalculateRouteSummary
impl PartialEq for CalculateRouteSummary
impl StructuralPartialEq for CalculateRouteSummary
Auto Trait Implementations§
impl Freeze for CalculateRouteSummary
impl RefUnwindSafe for CalculateRouteSummary
impl Send for CalculateRouteSummary
impl Sync for CalculateRouteSummary
impl Unpin for CalculateRouteSummary
impl UnwindSafe for CalculateRouteSummary
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);