Struct feroxide::ElemReaction

pub struct ElemReaction<E: Element> {
    pub lhs: ReactionSide<E>,
    pub rhs: ReactionSide<E>,
    pub is_equilibrium: bool,
}

An elementair reaction (not containing ions)

Fields

lhs: ReactionSide<E>

The left-hand-side

rhs: ReactionSide<E>

The right-hand-side

is_equilibrium: bool

Methods

impl<E: Element> ElemReaction<E>

fn ion_from_string(string: String) -> Option<ElemReaction<Ion>>

Convert a string representation of an elementary reaction into one

fn molecule_from_string(string: String) -> Option<ElemReaction<Molecule>>

Convert a string representation of a reaction into one

fn reaction_sign(&self) -> &str

Get the sign of the equation ( → or ⇌ ), depending whether it is an equilibrium or not

fn swap(self) -> Self

Swap the equation

Trait Implementations

impl<E: Debug + Element> Debug for ElemReaction<E>

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

Formats the value using the given formatter.

impl<E: Eq + Element> Eq for ElemReaction<E>

impl<E: PartialEq + Element> PartialEq for ElemReaction<E>

fn eq(&self, __arg_0: &ElemReaction<E>) -> bool

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

fn ne(&self, __arg_0: &ElemReaction<E>) -> bool

This method tests for !=.

impl<E: Clone + Element> Clone for ElemReaction<E>

fn clone(&self) -> ElemReaction<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Hash + Element> Hash for ElemReaction<E>

fn hash<__HE: Hasher>(&self, __arg_0: &mut __HE)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<E: Element> Reaction<E> for ElemReaction<E>

fn equalise(&self) -> bool

NOTE: This function is still a WIP!

fn is_valid(&self) -> bool

Check if the reaction is valid by comparing the amount of total atoms on both sides, and by checking if the total charge on both sides is equal

fn energy_cost(&self) -> Energy

Calculate the cost of this reaction This can be negative in case of an exothermic reaction

fn elem_reaction(&self) -> ElemReaction<E>

Get the ElemReaction version

impl<E: Element> Properties for ElemReaction<E>

fn symbol(&self) -> String

Get the symbol of the current item

fn name(&self) -> String

Get the name of the current item

fn mass(&self) -> AtomMass

Get the mass of the current item

fn stringify(&self) -> String

Stringify the current item (default: self.symbol())

impl<E: Element> Display for ElemReaction<E>

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

Formats the value using the given formatter.