Struct ReactionTerm 

pub struct ReactionTerm { /* private fields */ }

A formula-backed reaction term with a stoichiometric coefficient.

Implementations

impl ReactionTerm

pub fn new(formula: ChemicalFormula) -> Self

Creates a reaction term with coefficient one.

pub fn from_parts( coefficient: StoichiometricCoefficient, formula: ChemicalFormula, ) -> Result<Self, ReactionValidationError>

Creates a reaction term from validated parts.

Errors

Returns ReactionValidationError::InvalidStoichiometry if the stoichiometry primitive rejects the coefficient.

pub fn from_value( coefficient: u32, formula: ChemicalFormula, ) -> Result<Self, ReactionValidationError>

Creates a reaction term from a raw coefficient value.

Errors

Returns ReactionValidationError::InvalidStoichiometry when coefficient is zero.

pub fn with_coefficient( self, coefficient: u32, ) -> Result<Self, ReactionValidationError>

Returns a copy of this term with a new coefficient.

Errors

Returns ReactionValidationError::InvalidStoichiometry when coefficient is zero.

pub const fn coefficient(&self) -> StoichiometricCoefficient

Returns the stoichiometric coefficient.

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

Returns the chemical formula.

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

Returns the wrapped stoichiometric term.

pub fn into_stoichiometric_term(self) -> StoichiometricTerm

Consumes this value and returns the wrapped stoichiometric term.

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

Consumes the term and returns its parts.

Trait Implementations

impl Clone for ReactionTerm

fn clone(&self) -> ReactionTerm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReactionTerm

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

Formats the value using the given formatter.

impl Display for ReactionTerm

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

Formats the value using the given formatter.

impl From<ReactionTerm> for Product

fn from(term: ReactionTerm) -> Self

Converts to this type from the input type.

impl From<ReactionTerm> for Reactant

fn from(term: ReactionTerm) -> Self

Converts to this type from the input type.

impl From<StoichiometricTerm> for ReactionTerm

fn from(term: StoichiometricTerm) -> Self

Converts to this type from the input type.

impl PartialEq for ReactionTerm

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

impl StructuralPartialEq for ReactionTerm