#[non_exhaustive]pub struct CalculateRouteOutputBuilder { /* private fields */ }Expand description
A builder for CalculateRouteOutput.
Implementations§
Source§impl CalculateRouteOutputBuilder
impl CalculateRouteOutputBuilder
Sourcepub fn legs(self, input: Leg) -> Self
pub fn legs(self, input: Leg) -> Self
Appends an item to legs.
To override the contents of this collection use set_legs.
Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
-
The
StartPositionis the departure position. -
The
EndPositionis the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
-
Leg 1: The
StartPositionis the departure position . TheEndPositionis the waypoint positon. -
Leg 2: The
StartPositionis the waypoint position. TheEndPositionis the destination position.
Sourcepub fn set_legs(self, input: Option<Vec<Leg>>) -> Self
pub fn set_legs(self, input: Option<Vec<Leg>>) -> Self
Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
-
The
StartPositionis the departure position. -
The
EndPositionis the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
-
Leg 1: The
StartPositionis the departure position . TheEndPositionis the waypoint positon. -
Leg 2: The
StartPositionis the waypoint position. TheEndPositionis the destination position.
Sourcepub fn get_legs(&self) -> &Option<Vec<Leg>>
pub fn get_legs(&self) -> &Option<Vec<Leg>>
Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
-
The
StartPositionis the departure position. -
The
EndPositionis the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
-
Leg 1: The
StartPositionis the departure position . TheEndPositionis the waypoint positon. -
Leg 2: The
StartPositionis the waypoint position. TheEndPositionis the destination position.
Sourcepub fn summary(self, input: CalculateRouteSummary) -> Self
pub fn summary(self, input: CalculateRouteSummary) -> Self
Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.
Sourcepub fn set_summary(self, input: Option<CalculateRouteSummary>) -> Self
pub fn set_summary(self, input: Option<CalculateRouteSummary>) -> Self
Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.
Sourcepub fn get_summary(&self) -> &Option<CalculateRouteSummary>
pub fn get_summary(&self) -> &Option<CalculateRouteSummary>
Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.
Sourcepub fn build(self) -> Result<CalculateRouteOutput, BuildError>
pub fn build(self) -> Result<CalculateRouteOutput, BuildError>
Consumes the builder and constructs a CalculateRouteOutput.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for CalculateRouteOutputBuilder
impl Clone for CalculateRouteOutputBuilder
Source§fn clone(&self) -> CalculateRouteOutputBuilder
fn clone(&self) -> CalculateRouteOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CalculateRouteOutputBuilder
impl Debug for CalculateRouteOutputBuilder
Source§impl Default for CalculateRouteOutputBuilder
impl Default for CalculateRouteOutputBuilder
Source§fn default() -> CalculateRouteOutputBuilder
fn default() -> CalculateRouteOutputBuilder
impl StructuralPartialEq for CalculateRouteOutputBuilder
Auto Trait Implementations§
impl Freeze for CalculateRouteOutputBuilder
impl RefUnwindSafe for CalculateRouteOutputBuilder
impl Send for CalculateRouteOutputBuilder
impl Sync for CalculateRouteOutputBuilder
impl Unpin for CalculateRouteOutputBuilder
impl UnwindSafe for CalculateRouteOutputBuilder
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);