Struct GravitationalParameter 

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

A gravitational parameter (mu = GM), stored canonically in m³/s².

Construction

use space_units::GravitationalParameter;
let mu = GravitationalParameter::from_km3ps2(398_600.4418); // Earth

Typed arithmetic

• GravitationalParameter / Length → SpecificEnergy
• GravitationalParameter / Area → Acceleration

Implementations

impl GravitationalParameter

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

Create from m³/s².

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

Create from km³/s².

pub const fn in_m3ps2(self) -> f64

Get value in m³/s².

pub const fn in_km3ps2(self) -> f64

Get value in km³/s².

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

Get value in the specified GravitationalParameterUnit.

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

Return a display wrapper that formats this gravitational parameter in the given unit.

pub fn abs(self) -> Self

Return the absolute value of this gravitational parameter.

Trait Implementations

impl Add for GravitationalParameter

type Output = GravitationalParameter

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for GravitationalParameter

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for GravitationalParameter

fn clone(&self) -> GravitationalParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GravitationalParameter

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

Formats the value using the given formatter.

impl Default for GravitationalParameter

fn default() -> GravitationalParameter

Returns the “default value” for a type.

impl Display for GravitationalParameter

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

Formats the value using the given formatter.

impl Div<Area> for GravitationalParameter

type Output = Acceleration

The resulting type after applying the / operator.

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

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<f64> for GravitationalParameter

type Output = GravitationalParameter

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for GravitationalParameter

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f64> for GravitationalParameter

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl Mul<GravitationalParameter> for f64

type Output = GravitationalParameter

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for GravitationalParameter

type Output = GravitationalParameter

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for GravitationalParameter

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl Neg for GravitationalParameter

type Output = GravitationalParameter

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for GravitationalParameter

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

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

type Output = GravitationalParameter

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for GravitationalParameter

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for GravitationalParameter

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 GravitationalParameter

impl StructuralPartialEq for GravitationalParameter