mzannotate 0.1.0

Handle fragmentation of (complex) peptidoforms.
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

use std::path::Path;

use context_error::*;
use mzcore::parse_json::ParseJson;

use crate::annotation::model::FragmentationModel;

/// Parse a custom models JSON string. The parser is guaranteed to be backwards compatible
/// with any JSON made by the serde serialisation of the custom models in previous version of
/// the library.
/// # Errors
/// If the file could not be opened or parsed.
pub fn parse_custom_models(
    path: &Path,
) -> Result<Vec<(String, FragmentationModel)>, BoxedError<'static, BasicKind>> {
    let string = std::fs::read_to_string(path).map_err(|err| {
        BoxedError::new(
            BasicKind::Error,
            "Could not parse custom models file",
            err.to_string(),
            Context::default().source(path.to_string_lossy()).to_owned(),
        )
    })?;
    Vec::from_json(&string)
}

/// Parse a custom models JSON string. The parser is guaranteed to be backwards compatible
/// with any JSON made by the serde serialisation of the custom models in previous version of
/// the library.
/// # Errors
/// If the string could not be parsed.
pub fn parse_custom_models_str(
    value: &str,
) -> Result<Vec<(String, FragmentationModel)>, BoxedError<'_, BasicKind>> {
    Vec::from_json(value)
}

#[test]
#[expect(clippy::missing_panics_doc)]
fn test_reading_custom_models_json_2024() {
    let data = include_str!("custom_model_2024.json");
    let mods = parse_custom_models_str(data).unwrap();
    assert!(mods.len() > 1);
}

#[test]
#[expect(clippy::missing_panics_doc)]
fn test_reading_custom_models_json_2025() {
    let data = include_str!("custom_model_20250528.json");
    let mods = parse_custom_models_str(data).unwrap();
    assert!(mods.len() > 1);
}