Struct Distance 

pub struct Distance { /* private fields */ }

Implementations

impl Distance

pub fn from_parsecs(parsecs: f64) -> CoordResult<Self>

Creates a Distance from parsecs.

Valid Range

Must be positive and finite (0 < parsecs < ∞)

Errors

Returns CoordError::InvalidDistance if value is ≤0, infinite, or NaN.

pub fn from_light_years(ly: f64) -> CoordResult<Self>

Creates a Distance from light-years.

Valid Range

Must be positive and finite (0 < ly < ∞)

pub fn from_au(au: f64) -> CoordResult<Self>

Creates a Distance from astronomical units.

Valid Range

Must be positive and finite (0 < au < ∞)

pub fn from_kilometers(km: f64) -> CoordResult<Self>

Creates a Distance from kilometers.

Valid Range

Must be positive and finite (0 < km < ∞)

pub fn from_parallax_arcsec(parallax_arcsec: f64) -> CoordResult<Self>

Creates a Distance from parallax in arcseconds.

Valid Range

Must be positive and finite (0 < parallax_arcsec < ∞)

Note

Distance (parsecs) = 1 / parallax (arcsec)

pub fn from_parallax_milliarcsec(parallax_mas: f64) -> CoordResult<Self>

pub fn from_parallax_angle(parallax: Angle) -> CoordResult<Self>

pub fn parsecs(self) -> f64

pub fn light_years(self) -> f64

pub fn au(self) -> f64

pub fn kilometers(self) -> f64

pub fn parallax_arcsec(self) -> f64

pub fn parallax_milliarcsec(self) -> f64

pub fn parallax_angle(self) -> Angle

pub fn distance_modulus(self) -> f64

pub fn from_distance_modulus(dm: f64) -> CoordResult<Self>

pub fn is_galactic(self) -> bool

pub fn is_local_group(self) -> bool

pub fn parallax_uncertainty_mas(self, relative_error: f64) -> f64

pub fn proper_motion_distance_au( self, pm_mas_per_year: f64, dt_years: f64, ) -> f64

Trait Implementations

impl Add for Distance

type Output = Result<Distance, CoordError>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl Clone for Distance

fn clone(&self) -> Distance

Returns a duplicate of the value.

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 Display for Distance

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

Formats the value using the given formatter.

impl Div<f64> for Distance

type Output = Result<Distance, CoordError>

The resulting type after applying the / operator.

fn div(self, divisor: f64) -> Self::Output

Performs the / operation.

impl Mul<f64> for Distance

type Output = Result<Distance, CoordError>

The resulting type after applying the * operator.

fn mul(self, factor: f64) -> Self::Output

Performs the * operation.

impl PartialEq for Distance

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

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

type Output = Result<Distance, CoordError>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl Copy for Distance

impl StructuralPartialEq for Distance