Struct Energy 

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

An energy quantity, stored canonically in joules (J).

Construction

use space_units::Energy;
let e = Energy::from_kj(4.2);

Typed arithmetic

• Force * Length → Energy
• Energy / Time → Power
• Energy / Mass → SpecificEnergy

Implementations

impl Energy

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

Create from joules (J).

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

Create from kilojoules (kJ).

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

Create from megajoules (MJ).

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

Create from watt-hours (Wh).

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

Create from kilowatt-hours (kWh).

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

Create from electronvolts (eV).

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

Create from kilo-electronvolts (keV).

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

Create from mega-electronvolts (MeV).

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

Create from ergs (erg).

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

Create from British thermal units (BTU).

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

Create from thermochemical calories (cal).

pub const fn in_j(self) -> f64

Get value in joules (J).

pub const fn in_kj(self) -> f64

Get value in kilojoules (kJ).

pub const fn in_mj(self) -> f64

Get value in megajoules (MJ).

pub const fn in_wh(self) -> f64

Get value in watt-hours (Wh).

pub const fn in_kwh(self) -> f64

Get value in kilowatt-hours (kWh).

pub const fn in_ev(self) -> f64

Get value in electronvolts (eV).

pub const fn in_kev(self) -> f64

Get value in kilo-electronvolts (keV).

pub const fn in_mev(self) -> f64

Get value in mega-electronvolts (MeV).

pub const fn in_erg(self) -> f64

Get value in ergs (erg).

pub const fn in_btu(self) -> f64

Get value in British thermal units (BTU).

pub const fn in_cal(self) -> f64

Get value in thermochemical calories (cal).

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

Get value in the specified EnergyUnit.

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

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

pub fn abs(self) -> Self

Return the absolute value of this energy.

Trait Implementations

impl Add for Energy

type Output = Energy

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Energy

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Energy

fn clone(&self) -> Energy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Energy

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

Formats the value using the given formatter.

impl Default for Energy

fn default() -> Energy

Returns the “default value” for a type.

impl Display for Energy

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

Formats the value using the given formatter.

impl Div<ElectricCharge> for Energy

type Output = Voltage

The resulting type after applying the / operator.

fn div(self, rhs: ElectricCharge) -> Voltage

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<Mass> for Energy

type Output = SpecificEnergy

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Time> for Energy

type Output = Power

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for Energy

type Output = Energy

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Energy

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f64> for Energy

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl Mul<Energy> for f64

type Output = Energy

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Energy

type Output = Energy

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for Energy

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl Neg for Energy

type Output = Energy

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Energy

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

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

type Output = Energy

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Energy

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for Energy

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 Energy

impl StructuralPartialEq for Energy