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
//! CRAM record feature.

pub mod code;
pub mod substitution;

pub use self::code::Code;

use noodles_core::Position;

/// A CRAM record feature.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum Feature {
    /// A stretch of bases (position, bases).
    Bases(Position, Vec<u8>),
    /// A stretch of quality scores (position, quality scores).
    Scores(Position, Vec<u8>),
    /// A base-quality score pair (position, base, quality score).
    ReadBase(Position, u8, u8),
    /// A base substitution (position, code (read) / base (write)).
    Substitution(Position, substitution::Value),
    /// Inserted bases (position, bases).
    Insertion(Position, Vec<u8>),
    /// A number of deleted bases (position, length).
    Deletion(Position, usize),
    /// A single inserted base (position, base).
    InsertBase(Position, u8),
    /// A single quality score (position, score).
    QualityScore(Position, u8),
    /// A number of skipped bases (position, length).
    ReferenceSkip(Position, usize),
    /// Soft clipped bases (position, bases).
    SoftClip(Position, Vec<u8>),
    /// A number of padded bases (position, length).
    Padding(Position, usize),
    /// A number of hard clipped bases (position, length).
    HardClip(Position, usize),
}

impl Feature {
    /// Returns the feature code.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_core::Position;
    /// use noodles_cram::record::{feature::Code, Feature};
    ///
    /// let position = Position::try_from(8)?;
    /// let feature = Feature::Padding(position, 13);
    ///
    /// assert_eq!(feature.code(), Code::Padding);
    /// # Ok::<_, noodles_core::position::TryFromIntError>(())
    /// ```
    pub fn code(&self) -> Code {
        match self {
            Self::Bases(..) => Code::Bases,
            Self::Scores(..) => Code::Scores,
            Self::ReadBase(..) => Code::ReadBase,
            Self::Substitution(..) => Code::Substitution,
            Self::Insertion(..) => Code::Insertion,
            Self::Deletion(..) => Code::Deletion,
            Self::InsertBase(..) => Code::InsertBase,
            Self::QualityScore(..) => Code::QualityScore,
            Self::ReferenceSkip(..) => Code::ReferenceSkip,
            Self::SoftClip(..) => Code::SoftClip,
            Self::Padding(..) => Code::Padding,
            Self::HardClip(..) => Code::HardClip,
        }
    }

    /// Returns the feature position.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_core::Position;
    /// use noodles_cram::record::Feature;
    ///
    /// let position = Position::try_from(8)?;
    /// let feature = Feature::Padding(position, 13);
    ///
    /// assert_eq!(feature.position(), position);
    /// # Ok::<_, noodles_core::position::TryFromIntError>(())
    /// ```
    pub fn position(&self) -> Position {
        match self {
            Self::Bases(pos, _) => *pos,
            Self::Scores(pos, _) => *pos,
            Self::ReadBase(pos, _, _) => *pos,
            Self::Substitution(pos, _) => *pos,
            Self::Insertion(pos, _) => *pos,
            Self::Deletion(pos, _) => *pos,
            Self::InsertBase(pos, _) => *pos,
            Self::QualityScore(pos, _) => *pos,
            Self::ReferenceSkip(pos, _) => *pos,
            Self::SoftClip(pos, _) => *pos,
            Self::Padding(pos, _) => *pos,
            Self::HardClip(pos, _) => *pos,
        }
    }
}

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

    #[test]
    fn test_code() {
        let position = Position::MIN;

        assert_eq!(Feature::Bases(position, Vec::new()).code(), Code::Bases);
        assert_eq!(Feature::Scores(position, Vec::new()).code(), Code::Scores);
        assert_eq!(Feature::ReadBase(position, b'N', 0).code(), Code::ReadBase);
        assert_eq!(
            Feature::Substitution(position, substitution::Value::Code(0)).code(),
            Code::Substitution
        );
        assert_eq!(
            Feature::Insertion(position, Vec::new()).code(),
            Code::Insertion
        );
        assert_eq!(Feature::Deletion(position, 0).code(), Code::Deletion);
        assert_eq!(Feature::InsertBase(position, b'N').code(), Code::InsertBase);
        assert_eq!(
            Feature::QualityScore(position, 0).code(),
            Code::QualityScore
        );
        assert_eq!(
            Feature::ReferenceSkip(position, 0).code(),
            Code::ReferenceSkip
        );
        assert_eq!(
            Feature::SoftClip(position, Vec::new()).code(),
            Code::SoftClip
        );
        assert_eq!(Feature::Padding(position, 0).code(), Code::Padding);
        assert_eq!(Feature::HardClip(position, 0).code(), Code::HardClip);
    }

    #[test]
    fn test_position() {
        let position = Position::MIN;

        assert_eq!(Feature::Bases(position, Vec::new()).position(), position);
        assert_eq!(Feature::Scores(position, Vec::new()).position(), position);
        assert_eq!(Feature::ReadBase(position, b'N', 0).position(), position);
        assert_eq!(
            Feature::Substitution(position, substitution::Value::Code(0)).position(),
            position
        );
        assert_eq!(
            Feature::Insertion(position, Vec::new()).position(),
            position
        );
        assert_eq!(Feature::Deletion(position, 0).position(), position);
        assert_eq!(Feature::InsertBase(position, b'N').position(), position);
        assert_eq!(Feature::QualityScore(position, 0).position(), position);
        assert_eq!(Feature::ReferenceSkip(position, 0).position(), position);
        assert_eq!(Feature::SoftClip(position, Vec::new()).position(), position);
        assert_eq!(Feature::Padding(position, 0).position(), position);
        assert_eq!(Feature::HardClip(position, 0).position(), position);
    }
}