ionic-rs 0.2.0

Streamable binary format for mass-spectrometry data: lossless mzML conversion, random access, WebAssembly support
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
use serde::{Deserialize, Serialize};

use crate::accessions::{
    ACC_COMPRESSION_NONE, FLOAT_64BIT, INTENSITY_ARRAY, MZ_ARRAY, format_accession,
};

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct MzML {
    pub cv_list: Option<CvList>,
    pub file_description: Option<FileDescription>,
    pub referenceable_param_group_list: Option<ReferenceableParamGroupList>,
    pub sample_list: Option<SampleList>,
    pub instrument_list: Option<InstrumentList>,
    pub software_list: Option<SoftwareList>,
    pub data_processing_list: Option<DataProcessingList>,
    pub scan_settings_list: Option<ScanSettingsList>,
    pub run: Run,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CvList {
    pub count: Option<usize>,
    pub cv: Vec<CvEntry>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CvEntry {
    pub id: String,
    pub full_name: Option<String>,
    pub version: Option<String>,
    pub uri: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct IndexOffset {
    pub id_ref: Option<String>,
    pub offset: u64,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct IndexList {
    pub spectrum: Vec<IndexOffset>,
    pub chromatogram: Vec<IndexOffset>,
    pub index_list_offset: Option<u64>,
    pub file_checksum: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct IndexedmzML {
    pub mzml: MzML,
    pub index_list: IndexList,
    pub index_list_offset: Option<u64>,
    pub file_checksum: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CvParam {
    pub cv_ref: Option<String>,
    pub accession: Option<String>,
    pub name: String,
    pub value: Option<String>,
    pub unit_cv_ref: Option<String>,
    pub unit_name: Option<String>,
    pub unit_accession: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct UserParam {
    pub name: String,
    pub r#type: Option<String>,
    pub unit_accession: Option<String>,
    pub unit_cv_ref: Option<String>,
    pub unit_name: Option<String>,
    pub value: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ReferenceableParamGroupRef {
    pub r#ref: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DataProcessingList {
    pub count: Option<usize>,
    pub data_processing: Vec<DataProcessing>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DataProcessing {
    pub id: String,
    pub software_ref: Option<String>,
    pub processing_method: Vec<ProcessingMethod>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ProcessingMethod {
    pub order: Option<u32>,
    pub software_ref: Option<String>,
    pub referenceable_param_group_ref: Vec<ReferenceableParamGroupRef>,
    pub cv_param: Vec<CvParam>,
    pub user_param: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct FileDescription {
    pub file_content: FileContent,
    pub source_file_list: SourceFileList,
    pub contacts: Vec<Contact>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SourceFileList {
    pub count: Option<usize>,
    pub source_file: Vec<SourceFile>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SourceFile {
    pub id: String,
    pub name: String,
    pub location: String,
    pub referenceable_param_group_ref: Vec<ReferenceableParamGroupRef>,
    pub cv_param: Vec<CvParam>,
    pub user_param: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct FileContent {
    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Contact {
    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct InstrumentList {
    pub count: Option<usize>,
    pub instrument: Vec<Instrument>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Instrument {
    pub id: String,
    pub scan_settings_ref: Option<ScanSettingsRef>,
    pub cv_param: Vec<CvParam>,
    pub user_param: Vec<UserParam>,
    pub referenceable_param_group_ref: Vec<ReferenceableParamGroupRef>,
    pub component_list: Option<ComponentList>,
    pub software_ref: Option<InstrumentSoftwareRef>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ScanSettingsRef {
    pub r#ref: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ComponentList {
    pub count: Option<usize>,
    pub source: Vec<Source>,
    pub analyzer: Vec<Analyzer>,
    pub detector: Vec<Detector>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Source {
    pub order: Option<u32>,
    pub referenceable_param_group_ref: Vec<ReferenceableParamGroupRef>,
    pub cv_param: Vec<CvParam>,
    pub user_param: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Analyzer {
    pub order: Option<u32>,
    pub referenceable_param_group_ref: Vec<ReferenceableParamGroupRef>,
    pub cv_param: Vec<CvParam>,
    pub user_param: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Detector {
    pub order: Option<u32>,
    pub referenceable_param_group_ref: Vec<ReferenceableParamGroupRef>,
    pub cv_param: Vec<CvParam>,
    pub user_param: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct InstrumentSoftwareRef {
    pub r#ref: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ReferenceableParamGroupList {
    pub count: Option<usize>,
    pub referenceable_param_groups: Vec<ReferenceableParamGroup>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ReferenceableParamGroup {
    pub id: String,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SampleList {
    pub count: Option<u32>,
    pub samples: Vec<Sample>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Sample {
    pub id: String,
    pub name: String,
    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ScanSettingsList {
    pub count: Option<usize>,
    pub scan_settings: Vec<ScanSettings>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ScanSettings {
    pub id: Option<String>,
    pub instrument_configuration_ref: Option<String>,
    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
    pub source_file_ref_list: Option<SourceFileRefList>,
    pub target_list: Option<TargetList>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SourceFileRefList {
    pub count: Option<usize>,
    pub source_file_refs: Vec<SourceFileRef>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SourceFileRef {
    pub r#ref: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct TargetList {
    pub count: Option<usize>,
    pub targets: Vec<Target>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Target {
    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SoftwareList {
    pub count: Option<usize>,
    pub software: Vec<Software>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Software {
    pub id: String,
    pub version: Option<String>,
    pub software_param: Vec<SoftwareParam>,
    pub cv_param: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SoftwareParam {
    pub cv_ref: Option<String>,
    pub accession: String,
    pub name: String,
    pub version: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Run {
    pub id: String,
    pub start_time_stamp: Option<String>,
    pub default_instrument_configuration_ref: Option<String>,
    pub default_source_file_ref: Option<String>,
    pub sample_ref: Option<String>,

    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,

    pub source_file_ref_list: Option<SourceFileRefList>,
    pub spectrum_list: Option<SpectrumList>,
    pub chromatogram_list: Option<ChromatogramList>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SpectrumList {
    pub count: Option<usize>,
    pub default_data_processing_ref: Option<String>,
    pub spectra: Vec<Spectrum>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SpectrumDescription {
    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,

    pub scan_list: Option<ScanList>,
    pub precursor_list: Option<PrecursorList>,
    pub product_list: Option<ProductList>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ScanList {
    pub count: Option<usize>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub scans: Vec<Scan>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Scan {
    pub instrument_configuration_ref: Option<String>,
    pub external_spectrum_id: Option<String>,
    pub source_file_ref: Option<String>,
    pub spectrum_ref: Option<String>,

    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,

    pub scan_window_list: Option<ScanWindowList>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ScanWindowList {
    pub count: Option<usize>,
    pub scan_windows: Vec<ScanWindow>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ScanWindow {
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct PrecursorList {
    pub count: Option<usize>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
    pub precursors: Vec<Precursor>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Precursor {
    pub spectrum_ref: Option<String>,
    pub source_file_ref: Option<String>,
    pub external_spectrum_id: Option<String>,

    pub isolation_window: Option<IsolationWindow>,
    pub selected_ion_list: Option<SelectedIonList>,
    pub activation: Option<Activation>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct IsolationWindow {
    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SelectedIonList {
    pub count: Option<usize>,
    pub selected_ions: Vec<SelectedIon>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SelectedIon {
    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Activation {
    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ProductList {
    pub count: Option<usize>,
    pub products: Vec<Product>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Product {
    pub spectrum_ref: Option<String>,
    pub source_file_ref: Option<String>,
    pub external_spectrum_id: Option<String>,
    pub isolation_window: Option<IsolationWindow>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct BinaryDataArrayList {
    pub count: Option<usize>,
    pub binary_data_arrays: Vec<BinaryDataArray>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Copy, Eq)]
#[serde(rename_all = "snake_case")]
pub enum NumericType {
    Float16,
    Float32,
    Float64,
    Int64,
    Int32,
    Int16,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum NumericArray {
    F64(Vec<f64>),
    F32(Vec<f32>),
    F16(Vec<u16>),
    I64(Vec<i64>),
    I32(Vec<i32>),
    I16(Vec<i16>),
}

impl NumericArray {
    pub fn len(&self) -> usize {
        match self {
            Self::F64(v) => v.len(),
            Self::F32(v) => v.len(),
            Self::F16(v) => v.len(),
            Self::I64(v) => v.len(),
            Self::I32(v) => v.len(),
            Self::I16(v) => v.len(),
        }
    }

    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct BinaryDataArray {
    pub array_length: Option<usize>,
    pub encoded_length: Option<usize>,
    pub data_processing_ref: Option<String>,

    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,

    pub numeric_type: Option<NumericType>,
    pub binary: Option<NumericArray>,

    #[serde(skip)]
    pub pending_base64: Option<Vec<u8>>,
    #[serde(skip)]
    pub pending_zlib: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ChromatogramList {
    pub count: Option<usize>,
    pub default_data_processing_ref: Option<String>,
    pub chromatograms: Vec<Chromatogram>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Chromatogram {
    pub id: String,
    pub native_id: Option<String>,
    pub index: Option<u32>,
    pub default_array_length: Option<usize>,
    pub data_processing_ref: Option<String>,

    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,

    pub precursor: Option<Precursor>,
    pub product: Option<Product>,

    pub binary_data_array_list: Option<BinaryDataArrayList>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Spectrum {
    pub id: String,
    pub index: Option<u32>,
    pub scan_number: Option<u32>,
    pub default_array_length: Option<usize>,
    pub native_id: Option<String>,
    pub data_processing_ref: Option<String>,
    pub source_file_ref: Option<String>,
    pub spot_id: Option<String>,
    pub ms_level: Option<u32>,

    pub referenceable_param_group_refs: Vec<ReferenceableParamGroupRef>,
    pub cv_params: Vec<CvParam>,
    pub user_params: Vec<UserParam>,

    pub spectrum_description: Option<SpectrumDescription>,

    pub scan_list: Option<ScanList>,
    pub precursor_list: Option<PrecursorList>,
    pub product_list: Option<ProductList>,
    pub binary_data_array_list: Option<BinaryDataArrayList>,
}

impl Spectrum {
    pub fn new(id: impl Into<String>, mz: Vec<f64>, intensity: Vec<f64>) -> Self {
        let default_array_length = mz.len();
        let mz_array = float64_array(MZ_ARRAY, "m/z array", mz);
        let intensity_array = float64_array(INTENSITY_ARRAY, "intensity array", intensity);
        Self {
            id: id.into(),
            default_array_length: Some(default_array_length),
            binary_data_array_list: Some(BinaryDataArrayList {
                count: Some(2),
                binary_data_arrays: vec![mz_array, intensity_array],
            }),
            ..Default::default()
        }
    }
}

fn float64_array(accession_tail: u32, name: &str, values: Vec<f64>) -> BinaryDataArray {
    BinaryDataArray {
        array_length: Some(values.len()),
        numeric_type: Some(NumericType::Float64),
        cv_params: vec![
            CvParam {
                cv_ref: Some("MS".to_string()),
                accession: Some(format_accession(accession_tail)),
                name: name.to_string(),
                ..Default::default()
            },
            CvParam {
                cv_ref: Some("MS".to_string()),
                accession: Some(format_accession(FLOAT_64BIT)),
                name: "64-bit float".to_string(),
                ..Default::default()
            },
            CvParam {
                cv_ref: Some("MS".to_string()),
                accession: Some(ACC_COMPRESSION_NONE.to_string()),
                name: "no compression".to_string(),
                ..Default::default()
            },
        ],
        binary: Some(NumericArray::F64(values)),
        ..Default::default()
    }
}