noodles_cram/data_container/compression_header/
data_series_encoding_map.rs

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
//! CRAM data container compress header data series-encoding map.

mod builder;
pub(crate) mod data_series;

pub(crate) use self::builder::Builder;
pub use self::data_series::DataSeries;

use super::{
    encoding::codec::{Byte, ByteArray, Integer},
    Encoding,
};
use crate::container::block;

/// A container compression header data series encoding map.
#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) struct DataSeriesEncodingMap {
    bam_flags: Encoding<Integer>,
    cram_flags: Encoding<Integer>,
    reference_sequence_ids: Option<Encoding<Integer>>,
    read_lengths: Encoding<Integer>,
    alignment_starts: Encoding<Integer>,
    read_group_ids: Encoding<Integer>,
    names: Option<Encoding<ByteArray>>,
    mate_flags: Option<Encoding<Integer>>,
    mate_reference_sequence_ids: Option<Encoding<Integer>>,
    mate_alignment_starts: Option<Encoding<Integer>>,
    template_lengths: Option<Encoding<Integer>>,
    mate_distances: Option<Encoding<Integer>>,
    tag_set_ids: Encoding<Integer>,
    feature_counts: Option<Encoding<Integer>>,
    feature_codes: Option<Encoding<Byte>>,
    feature_position_deltas: Option<Encoding<Integer>>,
    deletion_lengths: Option<Encoding<Integer>>,
    stretches_of_bases: Option<Encoding<ByteArray>>,
    stretches_of_quality_scores: Option<Encoding<ByteArray>>,
    base_substitution_codes: Option<Encoding<Byte>>,
    insertion_bases: Option<Encoding<ByteArray>>,
    reference_skip_lengths: Option<Encoding<Integer>>,
    padding_lengths: Option<Encoding<Integer>>,
    hard_clip_lengths: Option<Encoding<Integer>>,
    soft_clip_bases: Option<Encoding<ByteArray>>,
    mapping_qualities: Option<Encoding<Integer>>,
    bases: Option<Encoding<Byte>>,
    quality_scores: Option<Encoding<Byte>>,
}

impl DataSeriesEncodingMap {
    pub(crate) fn builder() -> Builder {
        Builder::default()
    }

    pub fn len(&self) -> usize {
        // BAM bit flags, CRAM bit flags, read lengths, in-seq positions, read groups, tag IDs
        let mut n = 6;

        if self.reference_sequence_ids().is_some() {
            n += 1;
        }

        if self.names().is_some() {
            n += 1;
        }

        if self.mate_flags().is_some() {
            n += 1;
        }

        if self.mate_reference_sequence_ids().is_some() {
            n += 1;
        }

        if self.mate_alignment_starts().is_some() {
            n += 1;
        }

        if self.template_lengths().is_some() {
            n += 1;
        }

        if self.mate_distances().is_some() {
            n += 1;
        }

        if self.feature_counts().is_some() {
            n += 1;
        }

        if self.feature_codes().is_some() {
            n += 1;
        }

        if self.feature_position_deltas().is_some() {
            n += 1;
        }

        if self.deletion_lengths().is_some() {
            n += 1;
        }

        if self.stretches_of_bases().is_some() {
            n += 1;
        }

        if self.stretches_of_quality_scores().is_some() {
            n += 1;
        }

        if self.base_substitution_codes().is_some() {
            n += 1;
        }

        if self.insertion_bases().is_some() {
            n += 1;
        }

        if self.reference_skip_lengths().is_some() {
            n += 1;
        }

        if self.padding_lengths().is_some() {
            n += 1;
        }

        if self.hard_clip_lengths().is_some() {
            n += 1;
        }

        if self.soft_clip_bases().is_some() {
            n += 1;
        }

        if self.mapping_qualities().is_some() {
            n += 1;
        }

        if self.bases().is_some() {
            n += 1;
        }

        if self.quality_scores().is_some() {
            n += 1;
        }

        n
    }

    pub fn bam_flags(&self) -> &Encoding<Integer> {
        &self.bam_flags
    }

    pub fn cram_flags(&self) -> &Encoding<Integer> {
        &self.cram_flags
    }

    pub fn reference_sequence_ids(&self) -> Option<&Encoding<Integer>> {
        self.reference_sequence_ids.as_ref()
    }

    pub fn read_lengths(&self) -> &Encoding<Integer> {
        &self.read_lengths
    }

    pub fn alignment_starts(&self) -> &Encoding<Integer> {
        &self.alignment_starts
    }

    pub fn read_group_ids(&self) -> &Encoding<Integer> {
        &self.read_group_ids
    }

    pub fn names(&self) -> Option<&Encoding<ByteArray>> {
        self.names.as_ref()
    }

    pub fn mate_flags(&self) -> Option<&Encoding<Integer>> {
        self.mate_flags.as_ref()
    }

    pub fn mate_reference_sequence_ids(&self) -> Option<&Encoding<Integer>> {
        self.mate_reference_sequence_ids.as_ref()
    }

    pub fn mate_alignment_starts(&self) -> Option<&Encoding<Integer>> {
        self.mate_alignment_starts.as_ref()
    }

    pub fn template_lengths(&self) -> Option<&Encoding<Integer>> {
        self.template_lengths.as_ref()
    }

    pub fn mate_distances(&self) -> Option<&Encoding<Integer>> {
        self.mate_distances.as_ref()
    }

    pub fn tag_set_ids(&self) -> &Encoding<Integer> {
        &self.tag_set_ids
    }

    pub fn feature_counts(&self) -> Option<&Encoding<Integer>> {
        self.feature_counts.as_ref()
    }

    pub fn feature_codes(&self) -> Option<&Encoding<Byte>> {
        self.feature_codes.as_ref()
    }

    pub fn feature_position_deltas(&self) -> Option<&Encoding<Integer>> {
        self.feature_position_deltas.as_ref()
    }

    pub fn deletion_lengths(&self) -> Option<&Encoding<Integer>> {
        self.deletion_lengths.as_ref()
    }

    pub fn stretches_of_bases(&self) -> Option<&Encoding<ByteArray>> {
        self.stretches_of_bases.as_ref()
    }

    pub fn stretches_of_quality_scores(&self) -> Option<&Encoding<ByteArray>> {
        self.stretches_of_quality_scores.as_ref()
    }

    pub fn base_substitution_codes(&self) -> Option<&Encoding<Byte>> {
        self.base_substitution_codes.as_ref()
    }

    pub fn insertion_bases(&self) -> Option<&Encoding<ByteArray>> {
        self.insertion_bases.as_ref()
    }

    pub fn reference_skip_lengths(&self) -> Option<&Encoding<Integer>> {
        self.reference_skip_lengths.as_ref()
    }

    pub fn padding_lengths(&self) -> Option<&Encoding<Integer>> {
        self.padding_lengths.as_ref()
    }

    pub fn hard_clip_lengths(&self) -> Option<&Encoding<Integer>> {
        self.hard_clip_lengths.as_ref()
    }

    pub fn soft_clip_bases(&self) -> Option<&Encoding<ByteArray>> {
        self.soft_clip_bases.as_ref()
    }

    pub fn mapping_qualities(&self) -> Option<&Encoding<Integer>> {
        self.mapping_qualities.as_ref()
    }

    pub fn bases(&self) -> Option<&Encoding<Byte>> {
        self.bases.as_ref()
    }

    pub fn quality_scores(&self) -> Option<&Encoding<Byte>> {
        self.quality_scores.as_ref()
    }
}

impl Default for DataSeriesEncodingMap {
    fn default() -> Self {
        Self {
            bam_flags: Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::BamFlags),
            }),
            cram_flags: Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::CramFlags),
            }),
            reference_sequence_ids: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::ReferenceSequenceIds),
            })),
            read_lengths: Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::ReadLengths),
            }),
            alignment_starts: Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::AlignmentStarts),
            }),
            read_group_ids: Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::ReadGroupIds),
            }),
            names: Some(Encoding::new(ByteArray::ByteArrayStop {
                stop_byte: 0x00,
                block_content_id: block::ContentId::from(DataSeries::Names),
            })),
            mate_flags: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::MateFlags),
            })),
            mate_reference_sequence_ids: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::MateReferenceSequenceId),
            })),
            mate_alignment_starts: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::MateAlignmentStart),
            })),
            template_lengths: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::TemplateLengths),
            })),
            mate_distances: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::MateDistances),
            })),
            tag_set_ids: Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(13),
            }),
            feature_counts: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::FeatureCounts),
            })),
            feature_codes: Some(Encoding::new(Byte::External {
                block_content_id: block::ContentId::from(DataSeries::FeatureCodes),
            })),
            feature_position_deltas: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::FeaturePositionDeltas),
            })),
            deletion_lengths: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::DeletionLengths),
            })),
            stretches_of_bases: Some(Encoding::new(ByteArray::ByteArrayStop {
                stop_byte: 0x00,
                block_content_id: block::ContentId::from(DataSeries::StretchesOfBases),
            })),
            stretches_of_quality_scores: Some(Encoding::new(ByteArray::ByteArrayLen {
                len_encoding: Encoding::new(Integer::External {
                    block_content_id: block::ContentId::from(DataSeries::StretchesOfQualityScores),
                }),
                value_encoding: Encoding::new(Byte::External {
                    block_content_id: block::ContentId::from(DataSeries::StretchesOfQualityScores),
                }),
            })),
            base_substitution_codes: Some(Encoding::new(Byte::External {
                block_content_id: block::ContentId::from(DataSeries::BaseSubstitutionCodes),
            })),
            insertion_bases: Some(Encoding::new(ByteArray::ByteArrayStop {
                stop_byte: 0x00,
                block_content_id: block::ContentId::from(DataSeries::InsertionBases),
            })),
            reference_skip_lengths: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::ReferenceSkipLengths),
            })),
            padding_lengths: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::PaddingLengths),
            })),
            hard_clip_lengths: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::HardClipLengths),
            })),
            soft_clip_bases: Some(Encoding::new(ByteArray::ByteArrayStop {
                stop_byte: 0x00,
                block_content_id: block::ContentId::from(DataSeries::SoftClipBases),
            })),
            mapping_qualities: Some(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(DataSeries::MappingQualities),
            })),
            bases: Some(Encoding::new(Byte::External {
                block_content_id: block::ContentId::from(DataSeries::Bases),
            })),
            quality_scores: Some(Encoding::new(Byte::External {
                block_content_id: block::ContentId::from(DataSeries::QualityScores),
            })),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_len() -> Result<(), builder::BuildError> {
        let map = DataSeriesEncodingMap::default();
        assert_eq!(map.len(), 28);

        let map = DataSeriesEncodingMap::builder()
            .set_bam_flags(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(1),
            }))
            .set_cram_flags(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(2),
            }))
            .set_read_lengths(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(4),
            }))
            .set_alignment_starts(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(5),
            }))
            .set_read_group_ids(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(6),
            }))
            .set_tag_set_ids(Encoding::new(Integer::External {
                block_content_id: block::ContentId::from(13),
            }))
            .build()?;

        assert_eq!(map.len(), 6);

        Ok(())
    }
}