mzcore 0.2.0

Core logic for handling massspectrometry in Rust.
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

#![doc = include_str!("../README.md")]
#![expect(macro_use_extern_crate)] // Could not get uom to work without
use bincode as _;

#[macro_use]
mod helper_functions;

/// Contains all things related to the underlying chemistry.
pub mod chemistry;
/// Parse CSV files while keeping track of all necessary info to generate great error messages
pub mod csv;
pub mod glycan;
mod isobaric_sets;
pub mod ontology;
/// Contains logic to parse the custom modifications and custom models databases with backwards
/// compatibility
pub mod parse_json;
/// Contains all things related to tolerances and structures to handle multiple mass/formula
/// options.
pub mod quantities;
/// Contains all things related to sequences, amongst others amino acids and peptidoforms.
pub mod sequence;
/// Scaffold for querying the sice of things at runtime
#[doc(hidden)]
pub mod space;
pub mod system;

/// A subset of the types and traits that are envisioned to be used the most, importing this is a
/// good starting point for working with the crate
pub mod prelude {
    pub use crate::{
        chemistry::{
            AmbiguousMolecule, Element, MassMode, MassOutputMode, MassOutputType, MolecularCharge,
            MolecularFormula, Molecule,
        },
        isobaric_sets::{
            BuildingBlocks, IsobaricSetIterator, TerminalBuildingBlocks, building_blocks,
            find_isobaric_sets,
        },
        molecular_formula,
        sequence::{
            AminoAcid, CheckedAminoAcid, HasPeptidoformImpl, HasPeptidoformIon,
            HasPeptidoformIonSet, IsAminoAcid, Peptidoform, PeptidoformIon, PeptidoformIonSet,
            Protease, SequenceElement, SequencePosition,
        },
    };
}

#[macro_use]
extern crate uom;

/// The result of a parser, contains the result and a list of warnings if it succeeded and only a
/// list of errors if it failed.
pub type ParserResult<'a, T, Kind> =
    Result<(T, Vec<context_error::BoxedError<'a, Kind>>), Vec<context_error::BoxedError<'a, Kind>>>;