use-chemical-formula 0.1.0

Chemical formula primitives and lightweight parsing 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

use std::collections::BTreeMap;
use std::fmt;

use crate::{FormulaTerm, FormulaValidationError};

/// A contiguous formula part made of terms.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct FormulaPart {
    terms: Vec<FormulaTerm>,
}

impl FormulaPart {
    /// Creates a formula part.
    ///
    /// # Errors
    ///
    /// Returns [`FormulaValidationError::EmptyPart`] when `terms` is empty.
    pub fn new(terms: Vec<FormulaTerm>) -> Result<Self, FormulaValidationError> {
        if terms.is_empty() {
            Err(FormulaValidationError::EmptyPart)
        } else {
            Ok(Self { terms })
        }
    }

    /// Returns the terms in this part.
    #[must_use]
    pub fn terms(&self) -> &[FormulaTerm] {
        &self.terms
    }

    pub(crate) fn add_counts(&self, counts: &mut BTreeMap<String, u64>, multiplier: u64) {
        for term in &self.terms {
            term.add_counts(counts, multiplier);
        }
    }
}

impl fmt::Display for FormulaPart {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        for term in &self.terms {
            write!(formatter, "{term}")?;
        }
        Ok(())
    }
}