Enum google_maps::directions::request::traffic_model::TrafficModel

#[repr(u8)]
pub enum TrafficModel {
    BestGuess = 0,
    Optimistic = 1,
    Pessimistic = 2,
}

Specifies the traffic model to use when calculating time in traffic.

This setting affects the value returned in the duration_in_traffic field in the response, which contains the predicted time in traffic based on historical averages. The traffic_model parameter may only be specified for driving directions where the request includes a departure_time, and only if the request includes an API key or a Google Maps Platform Premium Plan client ID.

The default value of best_guess will give the most useful predictions for the vast majority of use cases. It is possible the best_guess travel time prediction may be shorter than optimistic, or alternatively, longer than pessimistic, due to the way the best_guess prediction model integrates live traffic information.

Variants

BestGuess = 0

Indicates that the returned duration_in_traffic should be the best estimate of travel time given what is known about both historical traffic conditions and live traffic. Live traffic becomes more important the closer the departure_time is to now.

Optimistic = 1

Indicates that the returned duration_in_traffic should be shorter than the actual travel time on most days, though occasional days with particularly good traffic conditions may be faster than this value.

Pessimistic = 2

Indicates that the returned duration_in_traffic should be longer than the actual travel time on most days, though occasional days with particularly bad traffic conditions may exceed this value.

Implementations

impl TrafficModel

pub const fn display(&self) -> &str

Formats a TrafficModel enum into a string that is presentable to the end user.

Trait Implementations

impl Clone for TrafficModel

fn clone(&self) -> TrafficModel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrafficModel

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

Formats the value using the given formatter.

impl Default for TrafficModel

fn default() -> TrafficModel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TrafficModel

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Manual implementation of Deserialize for serde. This will take advantage of the phf-powered TryFrom implementation for this type.

impl Display for TrafficModel

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

Converts a TrafficModel enum to a String that contains a traffic model code.

impl From<&TrafficModel> for &str

fn from(traffic_model: &TrafficModel) -> Self

Converts a TrafficModel enum to a String that contains a traffic model code.

impl From<&TrafficModel> for String

fn from(traffic_model: &TrafficModel) -> Self

Converts a TrafficModel enum to a String that contains a traffic model code.

impl FromStr for TrafficModel

fn from_str(traffic_model_code: &str) -> Result<Self, Self::Err>

Gets a TrafficModel enum from a String that contains a valid traffic model code.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for TrafficModel

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TrafficModel

fn cmp(&self, other: &TrafficModel) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for TrafficModel

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for TrafficModel

fn partial_cmp(&self, other: &TrafficModel) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TrafficModel

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Manual implementation of Serialize for serde.

impl TryFrom<&str> for TrafficModel

fn try_from(traffic_model_code: &str) -> Result<Self, Self::Error>

Gets a TrafficModel enum from a String that contains a valid traffic model code.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for TrafficModel

impl StructuralPartialEq for TrafficModel