Struct StoichiometricTerm 

pub struct StoichiometricTerm { /* private fields */ }

A stoichiometric coefficient paired with a formula.

Implementations

impl StoichiometricTerm

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

Creates a stoichiometric term from validated parts.

Errors

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

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

Creates a stoichiometric term 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 fn into_parts(self) -> (StoichiometricCoefficient, ChemicalFormula)

Consumes the term and returns its parts.

Trait Implementations

impl Clone for StoichiometricTerm

fn clone(&self) -> StoichiometricTerm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoichiometricTerm

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

Formats the value using the given formatter.

impl Display for StoichiometricTerm

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

Formats the value using the given formatter.

impl From<StoichiometricTerm> for ReactionTerm

fn from(term: StoichiometricTerm) -> ReactionTerm

Converts to this type from the input type.

impl PartialEq for StoichiometricTerm

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

impl StructuralPartialEq for StoichiometricTerm