use-stoichiometry 0.1.0

Stoichiometry 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

use std::error::Error;
use std::fmt;

/// Errors returned when constructing stoichiometry values.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum StoichiometryValidationError {
    /// A stoichiometric coefficient is zero.
    ZeroCoefficient,
    /// A ratio denominator is zero.
    ZeroRatioDenominator,
    /// A limiting-reagent label is empty.
    EmptyLimitingReagentLabel,
    /// An excess-reagent label is empty.
    EmptyExcessReagentLabel,
    /// A yield value is not finite.
    NonFiniteYield,
    /// A yield value is negative.
    NegativeYield,
    /// A theoretical yield value is zero or negative.
    NonPositiveTheoreticalYield,
    /// A reactant entry was required.
    ExpectedReactant,
    /// A product entry was required.
    ExpectedProduct,
}

impl fmt::Display for StoichiometryValidationError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::ZeroCoefficient => {
                formatter.write_str("stoichiometric coefficient must be greater than zero")
            },
            Self::ZeroRatioDenominator => {
                formatter.write_str("stoichiometric ratio denominator must be greater than zero")
            },
            Self::EmptyLimitingReagentLabel => {
                formatter.write_str("limiting-reagent label must not be empty")
            },
            Self::EmptyExcessReagentLabel => {
                formatter.write_str("excess-reagent label must not be empty")
            },
            Self::NonFiniteYield => formatter.write_str("yield value must be finite"),
            Self::NegativeYield => formatter.write_str("yield value must not be negative"),
            Self::NonPositiveTheoreticalYield => {
                formatter.write_str("theoretical yield must be greater than zero")
            },
            Self::ExpectedReactant => formatter.write_str("reaction entry must be a reactant"),
            Self::ExpectedProduct => formatter.write_str("reaction entry must be a product"),
        }
    }
}

impl Error for StoichiometryValidationError {}