use-oxidation-state 0.1.0

Oxidation-state 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

use std::fmt;

use crate::{OxidationState, OxidationStateValidationError};

/// A labeled oxidation-state assignment.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct OxidationStateAssignment {
    label: String,
    state: OxidationState,
}

impl OxidationStateAssignment {
    /// Creates an oxidation-state assignment.
    ///
    /// # Errors
    ///
    /// Returns [`OxidationStateValidationError::EmptyAssignmentLabel`] when `label` is
    /// empty or whitespace only.
    pub fn new(label: &str, state: OxidationState) -> Result<Self, OxidationStateValidationError> {
        let label = label.trim();

        if label.is_empty() {
            Err(OxidationStateValidationError::EmptyAssignmentLabel)
        } else {
            Ok(Self {
                label: label.to_owned(),
                state,
            })
        }
    }

    /// Returns the assignment label.
    #[must_use]
    pub fn label(&self) -> &str {
        &self.label
    }

    /// Returns the assigned oxidation state.
    #[must_use]
    pub const fn state(&self) -> OxidationState {
        self.state
    }

    /// Consumes the assignment and returns its parts.
    #[must_use]
    pub fn into_parts(self) -> (String, OxidationState) {
        (self.label, self.state)
    }
}

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