openmassspec-core 1.4.0

Shared types, traits, and mzML writer for open Rust mass-spec parsers.
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

//! `openmassspec-core` is the shared foundation for the open Rust mass-spec
//! parsers (`opentfraw`, `opentimstdf`, `openwraw`).
//!
//! It exposes:
//!
//! * Vendor-neutral spectrum / chromatogram / run records:
//!   [`SpectrumRecord`], [`PrecursorInfo`], [`ChromatogramRecord`],
//!   [`RunMetadata`], [`CvTerm`].
//! * Shared enums: [`Polarity`], [`ScanMode`], [`Analyzer`], [`MsPower`],
//!   [`Activation`], [`Compression`].
//! * A trait every vendor parser implements: [`SpectrumSource`].
//! * One canonical mzML 1.1.0 writer: [`write_mzml`] and
//!   [`write_indexed_mzml`] (zlib-compressed binary data arrays by default;
//!   [`write_mzml_with_compression`]/[`write_indexed_mzml_with_compression`]
//!   for explicit codec control).
//! * A streaming profile-to-centroid transform, [`Centroided`], that wraps
//!   any `SpectrumSource`.
//!
//! Each vendor crate is a standalone tool (a user can pull in `opentfraw`
//! alone and get parsing **and** mzML export); `openmassspec-core` is the
//! shared vocabulary that keeps the three parsers in lock-step.

mod centroid;
mod enums;
mod error;
mod mzml;
mod source;
mod types;

#[cfg(feature = "arrow")]
pub mod arrow;
pub mod conformance;

pub use centroid::Centroided;
pub use enums::{
    Activation, Analyzer, Compression, MobilityArrayKind, MsPower, Polarity, ScanMode,
};
pub use error::{Error, Result};
pub use mzml::{
    write_indexed_mzml, write_indexed_mzml_with_compression, write_mzml,
    write_mzml_with_compression,
};
pub use source::SpectrumSource;
pub use types::{ChromatogramRecord, CvTerm, PrecursorInfo, RunMetadata, SpectrumRecord};

/// Crate version (set from `Cargo.toml`).
pub const VERSION: &str = env!("CARGO_PKG_VERSION");