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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

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

use use_stoichiometry::StoichiometryValidationError;

/// Errors returned when constructing or validating reaction values.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ReactionValidationError {
    /// A reaction has no reactants and no products.
    EmptyReaction,
    /// A reaction has no reactants.
    MissingReactants,
    /// A reaction has no products.
    MissingProducts,
    /// A catalyst label is empty.
    EmptyCatalystLabel,
    /// A solvent label is empty.
    EmptySolventLabel,
    /// A temperature label is empty.
    EmptyTemperatureLabel,
    /// A pressure label is empty.
    EmptyPressureLabel,
    /// A generic condition label is empty.
    EmptyConditionLabel,
    /// A generic condition value is empty.
    EmptyConditionValue,
    /// A stoichiometry primitive rejected the value.
    InvalidStoichiometry(StoichiometryValidationError),
}

impl fmt::Display for ReactionValidationError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::EmptyReaction => {
                formatter.write_str("reaction must contain reactants and products")
            },
            Self::MissingReactants => {
                formatter.write_str("reaction must contain at least one reactant")
            },
            Self::MissingProducts => {
                formatter.write_str("reaction must contain at least one product")
            },
            Self::EmptyCatalystLabel => formatter.write_str("catalyst label must not be empty"),
            Self::EmptySolventLabel => formatter.write_str("solvent label must not be empty"),
            Self::EmptyTemperatureLabel => {
                formatter.write_str("temperature label must not be empty")
            },
            Self::EmptyPressureLabel => formatter.write_str("pressure label must not be empty"),
            Self::EmptyConditionLabel => formatter.write_str("condition label must not be empty"),
            Self::EmptyConditionValue => formatter.write_str("condition value must not be empty"),
            Self::InvalidStoichiometry(error) => {
                write!(formatter, "invalid stoichiometry: {error}")
            },
        }
    }
}

impl Error for ReactionValidationError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            Self::InvalidStoichiometry(error) => Some(error),
            _ => None,
        }
    }
}

impl From<StoichiometryValidationError> for ReactionValidationError {
    fn from(error: StoichiometryValidationError) -> Self {
        Self::InvalidStoichiometry(error)
    }
}