Struct Energy 

pub struct Energy { /* private fields */ }

Property that must be transferred to an object in order to perform work on or to heat it.

Definition: Force·Length

Reference unit: Joule (‘J’ = ‘N·m’ = ‘kg·m²/s²’)

Predefined units:

Symbol	Name	Definition	Equivalent in ‘J’
Nm	Newton Meter	N·m	1
Ws	Watt Second	W·s	1
kWh	Kilowatt Hour	kW·h	3600000

Implementations

impl Energy

pub fn abs(&self) -> Self

Returns the absolute value of the Energy value.

pub fn signum(&self) -> AmountT

Returns the sign of the Energy values amount.

Trait Implementations

impl Add for Energy

type Output = Energy

The resulting type after applying the + operator.

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

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() -> Self

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<&Duration> for &Energy

where Energy: Div<Duration>,

type Output = <Energy as Div<Duration>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Duration) -> Self::Output

Performs the / operation.

impl Div<&Duration> for Energy

where Self: Div<Duration>,

type Output = <Energy as Div<Duration>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Duration) -> Self::Output

Performs the / operation.

impl Div<&Force> for &Energy

where Energy: Div<Force>,

type Output = <Energy as Div<Force>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Force) -> Self::Output

Performs the / operation.

impl Div<&Force> for Energy

where Self: Div<Force>,

type Output = <Energy as Div<Force>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Force) -> Self::Output

Performs the / operation.

impl Div<&Length> for &Energy

where Energy: Div<Length>,

type Output = <Energy as Div<Length>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Length) -> Self::Output

Performs the / operation.

impl Div<&Length> for Energy

where Self: Div<Length>,

type Output = <Energy as Div<Length>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Length) -> Self::Output

Performs the / operation.

impl Div<&Power> for &Energy

where Energy: Div<Power>,

type Output = <Energy as Div<Power>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Power) -> Self::Output

Performs the / operation.

impl Div<&Power> for Energy

where Self: Div<Power>,

type Output = <Energy as Div<Power>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Power) -> Self::Output

Performs the / operation.

impl<'a> Div<Duration> for &'a Energy

where Energy: Div<Duration>,

type Output = <Energy as Div<Duration>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: Duration) -> Self::Output

Performs the / operation.

impl Div<Duration> for Energy

where Self: HasRefUnit, Duration: HasRefUnit,

type Output = Power

The resulting type after applying the / operator.

fn div(self, rhs: Duration) -> Self::Output

Performs the / operation.

impl<'a> Div<Force> for &'a Energy

where Energy: Div<Force>,

type Output = <Energy as Div<Force>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: Force) -> Self::Output

Performs the / operation.

impl Div<Force> for Energy

where Self: HasRefUnit, Force: HasRefUnit,

type Output = Length

The resulting type after applying the / operator.

fn div(self, rhs: Force) -> Self::Output

Performs the / operation.

impl<'a> Div<Length> for &'a Energy

where Energy: Div<Length>,

type Output = <Energy as Div<Length>>::Output

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Length> for Energy

where Self: HasRefUnit, Length: HasRefUnit,

type Output = Force

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a> Div<Power> for &'a Energy

where Energy: Div<Power>,

type Output = <Energy as Div<Power>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: Power) -> Self::Output

Performs the / operation.

impl Div<Power> for Energy

where Self: HasRefUnit, Power: HasRefUnit,

type Output = Duration

The resulting type after applying the / operator.

fn div(self, rhs: Power) -> Self::Output

Performs the / operation.

impl<PQ: Quantity> Div<Rate<Energy, PQ>> for Energy

type Output = PQ

The resulting type after applying the / operator.

fn div(self, rhs: Rate<Self, PQ>) -> Self::Output

Performs the / operation.

impl Div<f64> for Energy

type Output = Energy

The resulting type after applying the / operator.

fn div(self, rhs: AmountT) -> Self::Output

Performs the / operation.

impl Div for Energy

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f64> for Energy

fn div_assign(&mut self, rhs: AmountT)

Performs the /= operation.

impl HasRefUnit for Energy

const REF_UNIT: EnergyUnit = EnergyUnit::Joule

Unit used as reference for scaling the units of Self::UnitType.

fn unit_from_scale(amnt: AmountT) -> Option<Self::UnitType>

Returns Some(unit) where unit.scale() == amnt, or None if there is no such unit.

fn equiv_amount(&self, unit: Self::UnitType) -> AmountT

Returns factor so that factor * unit == self.

fn convert(&self, to_unit: Self::UnitType) -> Self

Returns qty where qty == self and qty.unit() is to_unit.

fn convert_assign(&mut self, to_unit: Self::UnitType)

Converts self to the equivalent to_unit.

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

Returns true, if self and other have equivalent amounts, otherwise false.

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

Returns the partial order of selfs amount and others eqivalent amount in selfs unit.

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

Returns the sum of self and other

fn add_assign(&mut self, rhs: Self)

Adds the unit-equivalent amount of other to self in place.

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

Returns the difference between self and other

fn sub_assign(&mut self, rhs: Self)

Subtracts the unit-equivalent amount of other from self in place.

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

Returns the quotient self / other

impl Mul<Energy> for AmountT

type Output = Energy

The resulting type after applying the * operator.

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

Performs the * operation.

impl<TQ: Quantity> Mul<Rate<TQ, Energy>> for Energy

type Output = TQ

The resulting type after applying the * operator.

fn mul(self, rhs: Rate<TQ, Self>) -> Self::Output

Performs the * operation.

impl Mul<f64> for Energy

type Output = Energy

The resulting type after applying the * operator.

fn mul(self, rhs: AmountT) -> Self::Output

Performs the * operation.

impl MulAssign<f64> for Energy

fn mul_assign(&mut self, rhs: AmountT)

Performs the *= operation.

impl Neg for Energy

type Output = Energy

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Energy

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

fn new(amount: AmountT, unit: Self::UnitType) -> Self

Creates a new Energy value with the given amount and unit.

fn amount(&self) -> AmountT

Returns the amount of the Energy value.

fn unit(&self) -> Self::UnitType

Returns the unit of the Energy value.

type UnitType = EnergyUnit

Associated type of unit

fn iter_units() -> impl Iterator<Item = Self::UnitType>

Returns an iterator over the variants of Self::UnitType.

fn unit_from_symbol(symbol: &str) -> Option<Self::UnitType>

Returns Some(unit) where unit.symbol() == symbol, or None if there is no such unit.

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

Return true if self and other have the same unit and their amounts are equal, otherwise false.

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

Returns the partial order of selfs and others amounts, if both have the same unit, otherwise None.

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

Returns the sum of self and other, if both have the same unit.

fn add_assign(&mut self, rhs: Self)

Adds the amount of other to self in place, if both have the same unit.

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

Returns the difference between self and other, if both have the same unit.

fn sub_assign(&mut self, rhs: Self)

Subtracts the amount of other from self in place, if both have the same unit.

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

Returns the quotient self / other, if both have the same unit.

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

Formats self using the given formatter.

impl Sub for Energy

type Output = Energy

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Energy

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Energy

impl Eq for Energy