Struct geom::Distance

pub struct Distance(f64);

A distance, in meters. Can be negative.

Implementations

impl Distance

pub const ZERO: Distance

pub fn meters(value: f64) -> Distance

Creates a distance in meters.

pub const fn const_meters(value: f64) -> Distance

pub fn inches(value: f64) -> Distance

Creates a distance in inches.

pub fn miles(value: f64) -> Distance

Creates a distance in miles.

pub fn centimeters(value: usize) -> Distance

Creates a distance in centimeters.

pub fn feet(value: f64) -> Distance

Creates a distance in feet.

pub fn abs(self) -> Distance

Returns the absolute value of this distance.

pub fn sqrt(self) -> Distance

Returns the square root of this distance.

pub fn inner_meters(self) -> f64

Returns the distance in meters. Prefer to work with type-safe Distances.

pub fn to_feet(self) -> f64

Returns the distance in feet.

pub fn to_string(self, fmt: &UnitFmt) -> String

Describes the distance according to formatting rules. Rounds to 1 decimal place for both small (feet and meters) and large (miles and kilometers) units.

pub fn safe_percent(self, other: Distance) -> f64

Calculates a percentage, usually in [0.0, 1.0], of self / other. If the denominator is zero, returns 0%.

pub fn round_up_for_axis(self) -> Distance

Rounds this distance up to a higher, more “even” value to use for buckets along a plot’s axis. Always rounds for imperial units (feet).

Trait Implementations

impl Add<Distance> for Distance

type Output = Distance

The resulting type after applying the + operator.

fn add(self, other: Distance) -> Distance

Performs the + operation.

impl AddAssign<Distance> for Distance

fn add_assign(&mut self, other: Distance)

Performs the += operation.

impl Clone for Distance

fn clone(&self) -> Distance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Distance

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

Formats the value using the given formatter.

impl Default for Distance

fn default() -> Distance

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Distance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Distance

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

Formats the value using the given formatter.

impl Div<Distance> for Distance

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: Distance) -> f64

Performs the / operation.

impl Div<Speed> for Distance

type Output = Duration

The resulting type after applying the / operator.

fn div(self, other: Speed) -> Duration

Performs the / operation.

impl Div<f64> for Distance

type Output = Distance

The resulting type after applying the / operator.

fn div(self, scalar: f64) -> Distance

Performs the / operation.

impl Mul<Distance> for f64

type Output = Distance

The resulting type after applying the * operator.

fn mul(self, other: Distance) -> Distance

Performs the * operation.

impl Mul<f64> for Distance

type Output = Distance

The resulting type after applying the * operator.

fn mul(self, scalar: f64) -> Distance

Performs the * operation.

impl Neg for Distance

type Output = Distance

The resulting type after applying the - operator.

fn neg(self) -> Distance

Performs the unary - operation.

impl Ord for Distance

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Distance> for Distance

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

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

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

This method tests for !=.

impl PartialOrd<Distance> for Distance

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 Distance

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

Serialize this value into the given Serde serializer.

impl Sub<Distance> for Distance

type Output = Distance

The resulting type after applying the - operator.

fn sub(self, other: Distance) -> Distance

Performs the - operation.

impl SubAssign<Distance> for Distance

fn sub_assign(&mut self, other: Distance)

Performs the -= operation.

impl Sum<Distance> for Distance

fn sum<I>(iter: I) -> Distance where
    I: Iterator<Item = Distance>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Distance

impl Eq for Distance

impl StructuralPartialEq for Distance