Struct Waypoint

#[non_exhaustive]
pub struct Waypoint {
    pub side_of_road: bool,
    pub location_type: Option<LocationType>,
}

Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles.

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.

side_of_road: bool

Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option works only for the ‘DRIVING’ travel mode, and when the ‘location_type’ is set to ‘location’.

location_type: Option<LocationType>

Different ways to represent a location.

Implementations

impl Waypoint

pub fn new() -> Self

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

Sets the value of side_of_road.

pub fn set_location_type<T: Into<Option<LocationType>>>(self, v: T) -> Self

Sets the value of location_type.

pub fn get_location(&self) -> Option<&Box<Location>>

The value of location_type if it holds a Location, None if the field is not set or holds a different branch.

pub fn get_place_id(&self) -> Option<&String>

The value of location_type if it holds a PlaceId, None if the field is not set or holds a different branch.

pub fn set_location<T: Into<Box<Location>>>(self, v: T) -> Self

Sets the value of location_type to hold a Location.

Note that all the setters affecting location_type are mutually exclusive.

pub fn set_place_id<T: Into<String>>(self, v: T) -> Self

Sets the value of location_type to hold a PlaceId.

Note that all the setters affecting location_type are mutually exclusive.

Trait Implementations

impl Clone for Waypoint

fn clone(&self) -> Waypoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Waypoint

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

Formats the value using the given formatter.

impl Default for Waypoint

fn default() -> Waypoint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Waypoint

where Waypoint: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Waypoint

fn typename() -> &'static str

The typename of this message.

fn to_map(&self) -> Result<Map<String, Value>, AnyError>

where Self: Sized + Serialize,

Store the value into a JSON object.

fn from_map(map: &Map<String, Value>) -> Result<Self, AnyError>

where Self: DeserializeOwned,

Extract the value from a JSON object.

impl PartialEq for Waypoint

fn eq(&self, other: &Waypoint) -> 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 Serialize for Waypoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Waypoint