#[non_exhaustive]pub struct CalculateRouteMatrixOutputBuilder { /* private fields */ }
Expand description
A builder for CalculateRouteMatrixOutput
.
Implementations§
Source§impl CalculateRouteMatrixOutputBuilder
impl CalculateRouteMatrixOutputBuilder
Sourcepub fn route_matrix(self, input: Vec<RouteMatrixEntry>) -> Self
pub fn route_matrix(self, input: Vec<RouteMatrixEntry>) -> Self
Appends an item to route_matrix
.
To override the contents of this collection use set_route_matrix
.
The calculated route matrix containing the results for all pairs of DeparturePositions
to DestinationPositions
. Each row corresponds to one entry in DeparturePositions
. Each entry in the row corresponds to the route from that entry in DeparturePositions
to an entry in DestinationPositions
.
Sourcepub fn set_route_matrix(self, input: Option<Vec<Vec<RouteMatrixEntry>>>) -> Self
pub fn set_route_matrix(self, input: Option<Vec<Vec<RouteMatrixEntry>>>) -> Self
The calculated route matrix containing the results for all pairs of DeparturePositions
to DestinationPositions
. Each row corresponds to one entry in DeparturePositions
. Each entry in the row corresponds to the route from that entry in DeparturePositions
to an entry in DestinationPositions
.
Sourcepub fn get_route_matrix(&self) -> &Option<Vec<Vec<RouteMatrixEntry>>>
pub fn get_route_matrix(&self) -> &Option<Vec<Vec<RouteMatrixEntry>>>
The calculated route matrix containing the results for all pairs of DeparturePositions
to DestinationPositions
. Each row corresponds to one entry in DeparturePositions
. Each entry in the row corresponds to the route from that entry in DeparturePositions
to an entry in DestinationPositions
.
Sourcepub fn snapped_departure_positions(self, input: Vec<f64>) -> Self
pub fn snapped_departure_positions(self, input: Vec<f64>) -> Self
Appends an item to snapped_departure_positions
.
To override the contents of this collection use set_snapped_departure_positions
.
For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix
.
Sourcepub fn set_snapped_departure_positions(
self,
input: Option<Vec<Vec<f64>>>,
) -> Self
pub fn set_snapped_departure_positions( self, input: Option<Vec<Vec<f64>>>, ) -> Self
For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix
.
Sourcepub fn get_snapped_departure_positions(&self) -> &Option<Vec<Vec<f64>>>
pub fn get_snapped_departure_positions(&self) -> &Option<Vec<Vec<f64>>>
For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix
.
Sourcepub fn snapped_destination_positions(self, input: Vec<f64>) -> Self
pub fn snapped_destination_positions(self, input: Vec<f64>) -> Self
Appends an item to snapped_destination_positions
.
To override the contents of this collection use set_snapped_destination_positions
.
The list of destination positions for the route matrix used for calculation of the RouteMatrix
.
Sourcepub fn set_snapped_destination_positions(
self,
input: Option<Vec<Vec<f64>>>,
) -> Self
pub fn set_snapped_destination_positions( self, input: Option<Vec<Vec<f64>>>, ) -> Self
The list of destination positions for the route matrix used for calculation of the RouteMatrix
.
Sourcepub fn get_snapped_destination_positions(&self) -> &Option<Vec<Vec<f64>>>
pub fn get_snapped_destination_positions(&self) -> &Option<Vec<Vec<f64>>>
The list of destination positions for the route matrix used for calculation of the RouteMatrix
.
Sourcepub fn summary(self, input: CalculateRouteMatrixSummary) -> Self
pub fn summary(self, input: CalculateRouteMatrixSummary) -> Self
Contains information about the route matrix, DataSource
, DistanceUnit
, RouteCount
and ErrorCount
.
Sourcepub fn set_summary(self, input: Option<CalculateRouteMatrixSummary>) -> Self
pub fn set_summary(self, input: Option<CalculateRouteMatrixSummary>) -> Self
Contains information about the route matrix, DataSource
, DistanceUnit
, RouteCount
and ErrorCount
.
Sourcepub fn get_summary(&self) -> &Option<CalculateRouteMatrixSummary>
pub fn get_summary(&self) -> &Option<CalculateRouteMatrixSummary>
Contains information about the route matrix, DataSource
, DistanceUnit
, RouteCount
and ErrorCount
.
Sourcepub fn build(self) -> Result<CalculateRouteMatrixOutput, BuildError>
pub fn build(self) -> Result<CalculateRouteMatrixOutput, BuildError>
Consumes the builder and constructs a CalculateRouteMatrixOutput
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for CalculateRouteMatrixOutputBuilder
impl Clone for CalculateRouteMatrixOutputBuilder
Source§fn clone(&self) -> CalculateRouteMatrixOutputBuilder
fn clone(&self) -> CalculateRouteMatrixOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for CalculateRouteMatrixOutputBuilder
impl Default for CalculateRouteMatrixOutputBuilder
Source§fn default() -> CalculateRouteMatrixOutputBuilder
fn default() -> CalculateRouteMatrixOutputBuilder
Source§impl PartialEq for CalculateRouteMatrixOutputBuilder
impl PartialEq for CalculateRouteMatrixOutputBuilder
Source§fn eq(&self, other: &CalculateRouteMatrixOutputBuilder) -> bool
fn eq(&self, other: &CalculateRouteMatrixOutputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CalculateRouteMatrixOutputBuilder
Auto Trait Implementations§
impl Freeze for CalculateRouteMatrixOutputBuilder
impl RefUnwindSafe for CalculateRouteMatrixOutputBuilder
impl Send for CalculateRouteMatrixOutputBuilder
impl Sync for CalculateRouteMatrixOutputBuilder
impl Unpin for CalculateRouteMatrixOutputBuilder
impl UnwindSafe for CalculateRouteMatrixOutputBuilder
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);