Struct measurements::energy::Energy

pub struct Energy { /* fields omitted */ }

The Energy struct can be used to deal with energies in a common way. Common metric and imperial units are supported.

Example

use measurements::Energy;

let energy = Energy::from_kcalories(2500.0);
println!("Some say a health adult male should consume {} per day", energy);

Methods

impl Energy

pub fn from_joules(joules: f64) -> Energy

Create a new Energy from a floating point value in Joules (or watt-seconds)

pub fn from_kcalories(kcalories: f64) -> Energy

Create a new Energy from a floating point value in Kilocalories (often just called calories)

pub fn from_btu(btu: f64) -> Energy

Create a new Energy from a floating point value in British Thermal Units

pub fn from_e_v(e_v: f64) -> Energy

Create a new Energy from a floating point value in electron Volts (eV).

pub fn from_watt_hours(wh: f64) -> Energy

Create a new Energy from a floating point value in Watt-hours (Wh)

pub fn from_kilowatt_hours(kwh: f64) -> Energy

Create a new Energy from a floating point value in Kilowatt-Hours (kWh)

pub fn as_joules(&self) -> f64

Convert this Energy into a floating point value in Joules (or watt-seconds)

pub fn as_kcalories(&self) -> f64

Convert this Energy into a floating point value in Kilocalories (often just called calories)

pub fn as_btu(&self) -> f64

Convert this Energy into a floating point value in British Thermal Units

pub fn as_e_v(&self) -> f64

Convert this Energy into a floating point value in electron volts (eV)

pub fn as_watt_hours(&self) -> f64

Convert this Energy into a floating point value in Watt-hours (Wh)

pub fn as_kilowatt_hours(&self) -> f64

Convert this Energy into a floating point value in kilowatt-hours (kWh)

Trait Implementations

impl Copy for Energy

impl Clone for Energy

fn clone(&self) -> Energy

Returns a copy 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 Measurement for Energy

fn as_base_units(&self) -> f64

Get this quantity in the base units

fn from_base_units(units: f64) -> Self

Create a new quantity from the base units

fn get_base_units_name(&self) -> &'static str

Return the base unit for this type, as a string. For example "kilograms"

fn get_appropriate_units(&self) -> (&'static str, f64)

Returns a string containing the most appropriate units for this quantity, and a floating point value representing this quantity in those units. Useful when, for example, a length might be in millimeters if it is very small, or kilometers when it is very large.

fn pick_appropriate_units(     &self,     list: &[(&'static str, f64)] ) -> (&'static str, f64)

Given a list of units and their scale relative to the base unit, select the most appropriate one.

impl Display for Energy

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

Formats the value using the given formatter.

impl Add for Energy

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub for Energy

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Div<Energy> for Energy

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for Energy

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Mul<f64> for Energy

type Output = Self

The resulting type after applying the * operator.

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

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

impl PartialEq for Energy

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl From<TorqueEnergy> for Energy

fn from(t: TorqueEnergy) -> Energy

Performs the conversion.

impl Div<Power> for Energy

type Output = Duration

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Duration> for Energy

type Output = Power

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Length> for Energy

type Output = Force

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Force> for Energy

type Output = Length

The resulting type after applying the / operator.

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

Performs the / operation.