Expand description
openmassspec-io is the umbrella crate that ties together the open
Rust mass-spec parsers (opentfraw, opentimstdf, openwraw,
openaraw, opensxraw) behind a uniform vendor-detection +
mzML-conversion API.
Each vendor parser is gated behind a Cargo feature
(thermo, bruker, waters, agilent, sciex) and re-exported
under vendor. The all meta-feature pulls in every supported
vendor.
Even with no features enabled, detect_format is available so
callers can probe a path without paying the compile-time cost of a
parser they will not use.
collect, convert_to_mzml, and convert_to_mzml_writer each
have a _centroided sibling that centroids every profile-mode
spectrum first via openmassspec_core::Centroided; this is always
opt-in, never the default.
Re-exports§
pub use openmassspec_core as core;
Modules§
- vendor
- Re-exports of each vendor parser, gated by feature.
Structs§
- Detected
- Result of probing a filesystem path for a supported vendor format.
- VecSource
- A trivial in-memory
openmassspec_core::SpectrumSourcebacked by aVec<SpectrumRecord>+ aopenmassspec_core::RunMetadata. Hand it toopenmassspec_core::write_mzmlwhen you already have the records in hand and just want to emit mzML.
Enums§
- Error
- Errors produced by the umbrella
openmassspec-ioAPI. - Vendor
Format - Detected on-disk vendor / format family.
Functions§
- collect
- Open the appropriate vendor source for
detected, collect every spectrum into aVec, and return both the records and the run-level metadata. Used by tools that need a second pass over the data (conformance validation,infosummaries, Arrow batching). - collect_
centroided - Like
collect, but every profile-mode spectrum is centroided first viaopenmassspec_core::Centroided. Already-centroided spectra pass through unchanged.min_intensity, whenSome, discards picked peaks below that noise floor. - convert_
to_ mzml - Convert a detected vendor file to mzML at
output. Picks the correct vendor crate’swrite_mzml(orwrite_indexed_mzml) based onindexed. - convert_
to_ mzml_ centroided - Like
convert_to_mzml, but every profile-mode spectrum is centroided first viaopenmassspec_core::Centroided.min_intensity, whenSome, discards picked peaks below that noise floor. - convert_
to_ mzml_ writer - Like
convert_to_mzmlbut writes to an arbitrary writer instead of a path. Useful for streaming output to gzip, stdout, or any other sink. - convert_
to_ mzml_ writer_ centroided - Like
convert_to_mzml_writer, but every profile-mode spectrum is centroided first viaopenmassspec_core::Centroided.min_intensity, whenSome, discards picked peaks below that noise floor. - detect_
format - Inspect
path(file or directory) and return the matching vendor format, orNonewhen none of the supported signatures match.
Type Aliases§
- Result
- Convenience alias mirroring the vendor crates.