use-ion 0.1.0

Ion identity and charge 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

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

/// Errors returned when constructing ion values.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum IonValidationError {
    /// An ion name is empty.
    EmptyName,
    /// A charge magnitude is zero.
    ZeroChargeMagnitude,
    /// An oxidation-state label is empty.
    EmptyOxidationStateLabel,
    /// A positive ion was required.
    ExpectedCation,
    /// A negative ion was required.
    ExpectedAnion,
    /// A monatomic formula was required.
    ExpectedMonatomicFormula,
    /// A polyatomic formula was required.
    ExpectedPolyatomicFormula,
}

impl fmt::Display for IonValidationError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::EmptyName => formatter.write_str("ion name must not be empty"),
            Self::ZeroChargeMagnitude => {
                formatter.write_str("ion charge magnitude must be greater than zero")
            },
            Self::EmptyOxidationStateLabel => {
                formatter.write_str("oxidation-state label must not be empty")
            },
            Self::ExpectedCation => formatter.write_str("ion must have a positive charge"),
            Self::ExpectedAnion => formatter.write_str("ion must have a negative charge"),
            Self::ExpectedMonatomicFormula => {
                formatter.write_str("ion formula must contain exactly one atom")
            },
            Self::ExpectedPolyatomicFormula => {
                formatter.write_str("ion formula must contain more than one atom")
            },
        }
    }
}

impl Error for IonValidationError {}