Struct Energy 

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

Energy in watt-hours, load convention: positive is energy taken in.

Implementations

impl Energy

pub const ZERO: Self

Zero watt-hours.

pub fn new(value: f64) -> Self

A value in watt-hours (Wh).

pub const fn new_const(value: f64) -> Self

A compile-time constant in watt-hours, unchecked.

pub const fn get(self) -> f64

The value in watt-hours.

pub fn is_finite(self) -> bool

true when the value is finite — the precondition every setpoint is checked against before it leaves the process.

pub fn max(self, other: Self) -> Self

The larger of two values. Propagates NaN rather than hiding it.

pub fn min(self, other: Self) -> Self

The smaller of two values. Propagates NaN rather than hiding it.

pub fn clamp(self, lo: Self, hi: Self) -> Self

Clamped into [lo, hi].

Panics

Panics when lo > hi, which is a programming error in the caller rather than a runtime condition.

pub fn abs(self) -> Self

The magnitude, sign discarded.

pub fn inflow(self) -> Self

The part flowing in (positive side of the load convention), or zero.

pub fn outflow(self) -> Self

The part flowing out as a non-negative magnitude, or zero.

impl Energy

pub fn from_kwh(kwh: f64) -> Self

An energy given in kilowatt-hours.

pub fn kwh(self) -> f64

The value in kilowatt-hours.

pub fn over(self, duration: Duration) -> Power

The constant power that would move this energy over duration.

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

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<'de> Deserialize<'de> for Energy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Energy

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

Formats the value using the given formatter.

impl Div 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 = Energy

The resulting type after applying the / operator.

fn div(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 Mul<f64> for Energy

type Output = Energy

The resulting type after applying the * operator.

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

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

Equality operator ==.

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

Inequality operator !=.

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Energy

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<'a> Sum<&'a Energy> for Energy

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.