Struct ReactionEntry 

pub struct ReactionEntry { /* private fields */ }

A stoichiometric entry on one side of a reaction.

Implementations

impl ReactionEntry

pub fn new( coefficient: StoichiometricCoefficient, formula: ChemicalFormula, side: ReactionSide, ) -> Result<ReactionEntry, StoichiometryValidationError>

Creates a reaction entry.

Errors

Returns StoichiometryValidationError::ZeroCoefficient if the coefficient is structurally invalid.

pub fn from_value( coefficient: u32, formula: ChemicalFormula, side: ReactionSide, ) -> Result<ReactionEntry, StoichiometryValidationError>

Creates a reaction entry from a raw coefficient value.

Errors

Returns StoichiometryValidationError::ZeroCoefficient when coefficient is zero.

pub const fn coefficient(&self) -> StoichiometricCoefficient

Returns the coefficient.

pub const fn formula(&self) -> &ChemicalFormula

Returns the formula.

pub const fn side(&self) -> ReactionSide

Returns the reaction side.

pub const fn term(&self) -> &StoichiometricTerm

Returns the stoichiometric term.

pub fn into_parts( self, ) -> (StoichiometricCoefficient, ChemicalFormula, ReactionSide)

Consumes the entry and returns its parts.

Trait Implementations

impl Clone for ReactionEntry

fn clone(&self) -> ReactionEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReactionEntry

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

Formats the value using the given formatter.

impl Display for ReactionEntry

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

Formats the value using the given formatter.

impl PartialEq for ReactionEntry

fn eq(&self, other: &ReactionEntry) -> 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 Eq for ReactionEntry

impl StructuralPartialEq for ReactionEntry