Struct TravelStep

#[non_exhaustive]
pub struct TravelStep {
    pub duration: Option<Duration>,
    pub distance_meters: f64,
    pub traffic_info_unavailable: bool,
    pub route_polyline: Option<EncodedPolyline>,
    /* private fields */
}

👎Deprecated

Deprecated: Use ShipmentRoute.Transition instead. Travel between each visit along the route: from the vehicle’s start_location to the first visit’s arrival_location, then from the first visit’s departure_location to the second visit’s arrival_location, and so on until the vehicle’s end_location. This accounts only for the actual travel between visits, not counting the waiting time, the time spent performing a visit, nor the distance covered during a visit.

Invariant: travel_steps_size() == visits_size() + 1.

If the vehicle does not have a start_ and/or end_location, the corresponding travel metrics are 0 and/or empty.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

duration: Option<Duration>

👎Deprecated

Duration of the travel step.

distance_meters: f64

👎Deprecated

Distance traveled during the step.

traffic_info_unavailable: bool

👎Deprecated

When traffic is requested via OptimizeToursRequest.consider_road_traffic, and the traffic info couldn’t be retrieved for a TravelStep, this boolean is set to true. This may be temporary (rare hiccup in the realtime traffic servers) or permanent (no data for this location).

route_polyline: Option<EncodedPolyline>

👎Deprecated

The encoded polyline representation of the route followed during the step.

This field is only populated if OptimizeToursRequest.populate_travel_step_polylines is set to true.

Implementations

impl TravelStep

pub fn new() -> Self

pub fn set_duration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of duration.

pub fn set_or_clear_duration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of duration.

pub fn set_distance_meters<T: Into<f64>>(self, v: T) -> Self

Sets the value of distance_meters.

pub fn set_traffic_info_unavailable<T: Into<bool>>(self, v: T) -> Self

Sets the value of traffic_info_unavailable.

pub fn set_route_polyline<T>(self, v: T) -> Self

where T: Into<EncodedPolyline>,

Sets the value of route_polyline.

pub fn set_or_clear_route_polyline<T>(self, v: Option<T>) -> Self

where T: Into<EncodedPolyline>,

Sets or clears the value of route_polyline.

Trait Implementations

impl Clone for TravelStep

fn clone(&self) -> TravelStep

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TravelStep

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TravelStep

fn default() -> TravelStep

Returns the “default value” for a type.

impl Message for TravelStep

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TravelStep

fn eq(&self, other: &TravelStep) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TravelStep