openproteo-io 1.0.1

Vendor-neutral mass-spec I/O: feature-gated re-exports of opentfraw / opentimstdf / openwraw with auto-detection and an mzML writer.
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

//! Typed error for the `openproteo-io` umbrella crate.
//!
//! Mirrors the `thiserror`-based pattern used by `openproteo-core` and
//! the vendor crates. Vendor-specific variants are feature-gated so
//! that a build excluding a vendor does not carry that vendor's error
//! type.

use std::path::PathBuf;

/// Errors produced by the umbrella `openproteo-io` API.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// The path did not match any supported vendor signature.
    #[error("unsupported vendor format at {0}")]
    UnsupportedFormat(PathBuf),

    /// A vendor format was detected but its feature was not enabled at
    /// build time.
    #[error("openproteo-io was built without the '{vendor}' feature")]
    FeatureDisabled { vendor: &'static str },

    /// Wrapping I/O error.
    #[error(transparent)]
    Io(#[from] std::io::Error),

    /// Wrapping `openproteo-core` error.
    #[error(transparent)]
    Core(#[from] openproteo_core::Error),

    /// Thermo (`opentfraw`) error.
    #[cfg(feature = "thermo")]
    #[error(transparent)]
    Thermo(#[from] opentfraw::Error),

    /// Bruker (`opentimstdf`) error.
    #[cfg(feature = "bruker")]
    #[error(transparent)]
    Bruker(#[from] opentimstdf::Error),

    /// Waters (`openwraw`) error.
    #[cfg(feature = "waters")]
    #[error(transparent)]
    Waters(#[from] openwraw::Error),

    /// mzML parsing error. Kept as a string until `mzdata` exposes a
    /// typed error suitable for `#[from]`.
    #[error("mzML error: {0}")]
    Mzml(String),
}

/// Convenience alias mirroring the vendor crates.
pub type Result<T> = std::result::Result<T, Error>;