Struct Length 

pub struct Length(/* private fields */);

A length / distance quantity, stored canonically in meters (m).

Construction

use space_units::prelude::*;

let a = Length::from_km(384_400.0);
let b = 384_400.0.km();        // NumericExt shorthand

Supported units

Constructor	Accessor	Unit
from_m	in_m	meter (m)
from_km	in_km	kilometer (km)
from_mm	in_mm	millimeter (mm)
from_cm	in_cm	centimeter (cm)
from_um	in_um	micrometer (um)
from_nm	in_nm	nanometer (nm)
from_au	in_au	astronomical unit (AU)
from_pc	in_pc	parsec (pc)
from_ly	in_ly	light-year (ly)
from_ft	in_ft	foot (ft)
from_nmi	in_nmi	nautical mile (nmi)
from_mi	in_mi	statute mile (mi)
from_earth_radii	in_earth_radii	Earth radius
from_solar_radii	in_solar_radii	Solar radius

Typed arithmetic

• Length / Time → Velocity
• Length / Velocity → Time
• Length × Length → Area
• Length × Velocity → SpecificAngularMomentum
• Length × Force → Energy
• Length × Area → Volume

Implementations

impl Length

pub const fn from_m(val: f64) -> Self

Create from meters (canonical unit).

pub const fn from_km(val: f64) -> Self

Create from kilometers. 1 km = 1 000 m.

pub const fn from_mm(val: f64) -> Self

Create from millimeters. 1 mm = 0.001 m.

pub const fn from_cm(val: f64) -> Self

Create from centimeters. 1 cm = 0.01 m.

pub const fn from_um(val: f64) -> Self

Create from micrometers. 1 um = 1e-6 m.

pub const fn from_nm(val: f64) -> Self

Create from nanometers. 1 nm = 1e-9 m.

pub const fn from_au(val: f64) -> Self

Create from astronomical units. 1 AU = 149 597 870 700 m.

pub const fn from_pc(val: f64) -> Self

Create from parsecs. 1 pc = 3.086e16 m.

pub const fn from_ly(val: f64) -> Self

Create from light-years. 1 ly = 9.461e15 m.

pub const fn from_ft(val: f64) -> Self

Create from feet. 1 ft = 0.3048 m.

pub const fn from_nmi(val: f64) -> Self

Create from nautical miles. 1 nmi = 1 852 m.

pub const fn from_mi(val: f64) -> Self

Create from statute miles. 1 mi = 1 609.344 m.

pub const fn from_earth_radii(val: f64) -> Self

Create from Earth radii. 1 R_earth = 6 371 000 m.

pub const fn from_solar_radii(val: f64) -> Self

Create from Solar radii. 1 R_sun = 6.957e8 m.

pub const fn in_m(self) -> f64

Get value in meters.

pub const fn in_km(self) -> f64

Get value in kilometers.

pub const fn in_mm(self) -> f64

Get value in millimeters.

pub const fn in_cm(self) -> f64

Get value in centimeters.

pub const fn in_um(self) -> f64

Get value in micrometers.

pub const fn in_nm(self) -> f64

Get value in nanometers.

pub const fn in_au(self) -> f64

Get value in astronomical units.

pub const fn in_pc(self) -> f64

Get value in parsecs.

pub const fn in_ly(self) -> f64

Get value in light-years.

pub const fn in_ft(self) -> f64

Get value in feet.

pub const fn in_nmi(self) -> f64

Get value in nautical miles.

pub const fn in_mi(self) -> f64

Get value in statute miles.

pub const fn in_earth_radii(self) -> f64

Get value in Earth radii.

pub const fn in_solar_radii(self) -> f64

Get value in Solar radii.

pub fn in_unit(self, unit: LengthUnit) -> f64

Get value in the specified LengthUnit.

pub fn display_as(self, unit: LengthUnit) -> DisplayWithUnit

Return a DisplayWithUnit for formatted printing in the given unit.

pub fn abs(self) -> Self

Absolute value.

Trait Implementations

impl Add for Length

type Output = Length

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl AddAssign for Length

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Length

fn clone(&self) -> Length

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Length

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

Formats the value using the given formatter.

impl Default for Length

fn default() -> Length

Returns the “default value” for a type.

impl Display for Length

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

Formats the value using the given formatter.

impl Div<Length> for Area

type Output = Length

The resulting type after applying the / operator.

fn div(self, rhs: Length) -> Length

Performs the / operation.

impl Div<Length> for Energy

type Output = Force

The resulting type after applying the / operator.

fn div(self, rhs: Length) -> Force

Performs the / operation.

impl Div<Length> for GravitationalParameter

type Output = SpecificEnergy

The resulting type after applying the / operator.

fn div(self, rhs: Length) -> SpecificEnergy

Performs the / operation.

impl Div<Length> for Volume

type Output = Area

The resulting type after applying the / operator.

fn div(self, rhs: Length) -> Area

Performs the / operation.

impl Div<Time> for Length

type Output = Velocity

The resulting type after applying the / operator.

fn div(self, rhs: Time) -> Velocity

Performs the / operation.

impl Div<Velocity> for Length

type Output = Time

The resulting type after applying the / operator.

fn div(self, rhs: Velocity) -> Time

Performs the / operation.

impl Div<f64> for Length

type Output = Length

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self

Performs the / operation.

impl Div for Length

type Output = f64

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> f64

Performs the / operation.

impl DivAssign<f64> for Length

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl Mul<Area> for Length

type Output = Volume

The resulting type after applying the * operator.

fn mul(self, rhs: Area) -> Volume

Performs the * operation.

impl Mul<Force> for Length

type Output = Energy

The resulting type after applying the * operator.

fn mul(self, rhs: Force) -> Energy

Performs the * operation.

impl Mul<Length> for Area

type Output = Volume

The resulting type after applying the * operator.

fn mul(self, rhs: Length) -> Volume

Performs the * operation.

impl Mul<Length> for Force

type Output = Energy

The resulting type after applying the * operator.

fn mul(self, rhs: Length) -> Energy

Performs the * operation.

impl Mul<Length> for Velocity

type Output = SpecificAngularMomentum

The resulting type after applying the * operator.

fn mul(self, rhs: Length) -> SpecificAngularMomentum

Performs the * operation.

impl Mul<Length> for f64

type Output = Length

The resulting type after applying the * operator.

fn mul(self, rhs: Length) -> Length

Performs the * operation.

impl Mul<Velocity> for Length

type Output = SpecificAngularMomentum

The resulting type after applying the * operator.

fn mul(self, rhs: Velocity) -> SpecificAngularMomentum

Performs the * operation.

impl Mul<f64> for Length

type Output = Length

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self

Performs the * operation.

impl Mul for Length

type Output = Area

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Area

Performs the * operation.

impl MulAssign<f64> for Length

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl Neg for Length

type Output = Length

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Length

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

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

type Output = Length

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl SubAssign for Length

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for Length

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Length

impl StructuralPartialEq for Length