Skip to main content

Crate openproteo_io

Crate openproteo_io 

Source
Expand description

openproteo-io is the umbrella crate that ties together the open Rust mass-spec parsers (opentfraw, opentimstdf, openwraw) behind a uniform vendor-detection + mzML-conversion API.

Each vendor parser is gated behind a Cargo feature (thermo, bruker, waters) 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.

Re-exports§

pub use openproteo_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 openproteo_core::SpectrumSource backed by a Vec<SpectrumRecord> + a openproteo_core::RunMetadata. Hand it to openproteo_core::write_mzml when you already have the records in hand and just want to emit mzML.

Enums§

Error
Errors produced by the umbrella openproteo-io API.
VendorFormat
Detected on-disk vendor / format family.

Functions§

collect
Open the appropriate vendor source for detected, collect every spectrum into a Vec, and return both the records and the run-level metadata. Used by tools that need a second pass over the data (conformance validation, info summaries, Arrow batching).
convert_to_mzml
Convert a detected vendor file to mzML at output. Picks the correct vendor crate’s write_mzml (or write_indexed_mzml) based on indexed.
convert_to_mzml_writer
Like convert_to_mzml but writes to an arbitrary writer instead of a path. Useful for streaming output to gzip, stdout, or any other sink.
detect_format
Inspect path (file or directory) and return the matching vendor format, or None when none of the supported signatures match.

Type Aliases§

Result
Convenience alias mirroring the vendor crates.