use-reaction 0.1.0

Chemical reaction representation primitives for RustUse
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

use std::fmt;

use use_chemical_formula::ChemicalFormula;
use use_stoichiometry::StoichiometricCoefficient;

use crate::ReactionTerm;

/// A reactant-side reaction term.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Reactant(ReactionTerm);

impl Reactant {
    /// Creates a reactant wrapper.
    #[must_use]
    pub const fn new(term: ReactionTerm) -> Self {
        Self(term)
    }

    /// Returns the wrapped reaction term.
    #[must_use]
    pub const fn as_term(&self) -> &ReactionTerm {
        &self.0
    }

    /// Consumes this value and returns the wrapped reaction term.
    #[must_use]
    pub fn into_term(self) -> ReactionTerm {
        self.0
    }

    /// Returns the stoichiometric coefficient.
    #[must_use]
    pub const fn coefficient(&self) -> StoichiometricCoefficient {
        self.0.coefficient()
    }

    /// Returns the chemical formula.
    #[must_use]
    pub const fn formula(&self) -> &ChemicalFormula {
        self.0.formula()
    }
}

impl From<ReactionTerm> for Reactant {
    fn from(term: ReactionTerm) -> Self {
        Self::new(term)
    }
}

impl fmt::Display for Reactant {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(formatter, "{}", self.0)
    }
}