Enum UnitSystem 

#[repr(u8)]
pub enum UnitSystem {
    Imperial = 0,
    Metric = 1,
}

Specifies the unit system to use when displaying results.

Directions results contain text within distance fields that may be displayed to the user to indicate the distance of a particular “step” of the route. By default, this text uses the unit system of the origin’s country or region.

For example, a route from “Chicago, IL” to “Toronto, ONT” will display results in miles, while the reverse route will display results in kilometers. You may override this unit system by setting one explicitly within the request’s units parameter, passing one of the following values:

Note: this unit system setting only affects the text displayed within distance fields. The distance fields also contain values which are always expressed in meters.

Variants

Imperial = 0

Specifies that distances in the response should be expressed in imperial units, miles and feet.

Metric = 1

Specifies that distances in the response should be expressed in metric units, using kilometres and metres.

Implementations

impl UnitSystem

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

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

Trait Implementations

impl Clone for UnitSystem

fn clone(&self) -> UnitSystem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnitSystem

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

Formats the value using the given formatter.

impl Default for UnitSystem

fn default() -> UnitSystem

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UnitSystem

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 UnitSystem

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

Converts a UnitSystem enum to a String that contains a unit system code.

impl From<&UnitSystem> for &str

fn from(units: &UnitSystem) -> Self

Converts a UnitSystem enum to a String that contains a unit system code.

impl From<&UnitSystem> for String

fn from(unit_system: &UnitSystem) -> Self

Converts a UnitSystem enum to a String that contains a unit system code.

impl FromStr for UnitSystem

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

Gets a UnitSystem enum from a String that contains a valid unit system code.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for UnitSystem

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 UnitSystem

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

Restrict a value to a certain interval.

impl PartialEq for UnitSystem

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for UnitSystem

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

where S: Serializer,

Manual implementation of Serialize for serde.

impl TryFrom<&str> for UnitSystem

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

Gets a UnitSystem enum from a String that contains a valid unit system code.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for UnitSystem

impl StructuralPartialEq for UnitSystem