Struct Soc 

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

State of charge as a fraction in [0, 1].

Constructed strictly, because a SoC outside the interval is either a driver bug or a unit mix-up (percent vs. fraction) and both are worth failing on. Soc::clamped exists for sensor noise around the endpoints.

Implementations

impl Soc

pub const EMPTY: Self

Empty.

pub const ZERO_RESERVE: Self

No backup reserve — the default for a battery that keeps nothing back.

pub const FULL: Self

Full.

pub fn new(fraction: f64) -> Result<Self, UnitError>

A state of charge from a fraction in [0, 1].

Errors

UnitError::SocOutOfRange when the value is outside [0, 1] or not finite.

pub fn from_percent(percent: f64) -> Result<Self, UnitError>

A state of charge from a percentage in [0, 100].

Errors

UnitError::SocOutOfRange when the value is outside [0, 100].

pub fn clamped(fraction: f64) -> Self

A state of charge clamped into [0, 1] — for sensors that report 100.4 %. A non-finite input becomes Soc::EMPTY, the safe end for every decision that reads a SoC (never discharge on a broken reading).

pub const fn fraction(self) -> f64

The fraction in [0, 1].

pub fn percent(self) -> f64

The percentage in [0, 100].

pub fn energy_in(self, capacity: Energy) -> Energy

The energy stored in a battery of capacity at this state of charge.

Trait Implementations

impl Clone for Soc

fn clone(&self) -> Soc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Soc

impl Debug for Soc

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

Formats the value using the given formatter.

impl Default for Soc

fn default() -> Soc

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Soc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Soc

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

Formats the value using the given formatter.

impl From<Soc> for f64

fn from(value: Soc) -> Self

Converts to this type from the input type.

impl PartialEq for Soc

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Soc

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

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 Soc

impl TryFrom<f64> for Soc

type Error = UnitError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.