Enum google_maps::directions::request::avoid::Avoid

#[repr(u8)]
pub enum Avoid {
    Ferries = 0,
    Highways = 1,
    Indoor = 2,
    Tolls = 3,
}

Used to specify features that calculated routes should avoid.

Directions may be calculated that adhere to certain restrictions. Restrictions are indicated by use of the avoid parameter, and an argument to that parameter indicating the restriction to avoid. The following restrictions are supported:

• Tolls
• Highways
• Ferries

It’s possible to request a route that avoids any combination of tolls, highways and ferries by passing both restrictions to the avoid parameter. For example: avoid=tolls|highways|ferries.

Note: the addition of restrictions does not preclude routes that include the restricted feature; it simply biases the result to more favorable routes.

Variants

Ferries = 0

Indicates that the calculated route should avoid ferries.

Highways = 1

Indicates that the calculated route should avoid highways.

Indoor = 2

Indicates that the calculated route should avoid indoor steps for walking and transit directions. Only requests that include an API key or a Google Maps Platform Premium Plan client ID will receive indoor steps by default.

Tolls = 3

Indicates that the calculated route should avoid toll roads/bridges.

Implementations

impl Avoid

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

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

Trait Implementations

impl Clone for Avoid

fn clone(&self) -> Avoid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Avoid

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

Formats the value using the given formatter.

impl Default for Avoid

fn default() -> Avoid

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Avoid

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 Avoid

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

Converts an Avoid enum to a String that contains a restrictions code.

impl From<&Avoid> for &str

fn from(avoid: &Avoid) -> Self

Converts an Avoid enum to a String that contains a restrictions code.

impl From<&Avoid> for String

fn from(avoid: &Avoid) -> Self

Converts an Avoid enum to a String that contains a restrictions code.

impl FromStr for Avoid

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

Gets an Avoid enum from a String that contains a valid restrictions code.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for Avoid

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 Avoid

fn cmp(&self, other: &Avoid) -> 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 Avoid

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

fn partial_cmp(&self, other: &Avoid) -> 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 Avoid

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

where S: Serializer,

Manual implementation of Serialize for serde.

impl TryFrom<&str> for Avoid

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

Gets an Avoid enum from a String that contains a valid restrictions code.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for Avoid

impl StructuralPartialEq for Avoid