molecular-formulas 0.1.9

A Rust crate for parsing, manipulating, and analyzing molecular formulas.
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

//! Module defining traits and structures for parsing chemical formulas.

use alloc::vec::Vec;
use core::iter::Peekable;

use crate::{MolecularFormulaMetadata, errors::ParserError, parsable::ParsableMolecularTree};

/// Trait defining a parsable chemical formula.
pub(crate) trait ParsableFormula: MolecularFormulaMetadata {
    /// Expected output type of the start hook call.
    type StartOutput;
    /// The molecular tree to construct.
    type Tree: ParsableMolecularTree<Self::Count>;

    /// Creates a new Molecular Formula from the start output and the mixtures.
    fn from_parsed(
        start_output: Self::StartOutput,
        mixtures: Vec<(Self::Count, Self::Tree)>,
    ) -> Result<Self, ParserError>;

    /// Hook called at the start of the parsing process.
    fn on_start<J>(chars: &mut Peekable<J>) -> Result<Self::StartOutput, ParserError>
    where
        J: Iterator<Item = char>;
}