use-molecule 0.1.0

Molecular identity 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

use std::fmt;

/// A formal molecule charge.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct MoleculeCharge(i16);

impl MoleculeCharge {
    /// Neutral charge.
    pub const NEUTRAL: Self = Self(0);

    /// Creates a molecule charge.
    #[must_use]
    pub const fn new(charge: i16) -> Self {
        Self(charge)
    }

    /// Returns the signed charge value.
    #[must_use]
    pub const fn get(self) -> i16 {
        self.0
    }

    /// Returns `true` when the charge is neutral.
    #[must_use]
    pub const fn is_neutral(self) -> bool {
        self.0 == 0
    }
}

impl Default for MoleculeCharge {
    fn default() -> Self {
        Self::NEUTRAL
    }
}

impl fmt::Display for MoleculeCharge {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self.0.cmp(&0) {
            std::cmp::Ordering::Greater => write!(formatter, "+{}", self.0),
            std::cmp::Ordering::Equal => formatter.write_str("0"),
            std::cmp::Ordering::Less => write!(formatter, "{}", self.0),
        }
    }
}