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

bitflags::bitflags! {
    /// CRAM record flags.
    #[derive(Default)]
    pub struct Flags: u8 {
        /// The per-base quality scores are stored as an array, as opposed to read features
        /// (`0x01`).
        const QUALITY_SCORES_STORED_AS_ARRAY = 0x01;
        /// The mate is in another slice (`0x02`).
        const DETACHED = 0x02;
        /// The mate is after the current record (`0x04`).
        const HAS_MATE_DOWNSTREAM = 0x04;
        /// The sequence is unknown (`0x08`).
        const DECODE_SEQUENCE_AS_UNKNOWN = 0x08;
    }
}

impl Flags {
    /// Returns whether the `QUALITY_SCORES_STORED_AS_ARRAY` flag is set.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_cram::record::Flags;
    /// let flags = Flags::QUALITY_SCORES_STORED_AS_ARRAY;
    /// assert!(flags.are_quality_scores_stored_as_array());
    /// ```
    pub fn are_quality_scores_stored_as_array(self) -> bool {
        self.contains(Self::QUALITY_SCORES_STORED_AS_ARRAY)
    }

    /// Returns whether the `DETACHED` flag is set.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_cram::record::Flags;
    /// assert!(Flags::DETACHED.is_detached());
    /// ```
    pub fn is_detached(self) -> bool {
        self.contains(Self::DETACHED)
    }

    /// Returns whether the `HAS_MATE_DOWNSTREAM` flag is set.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_cram::record::Flags;
    /// assert!(Flags::HAS_MATE_DOWNSTREAM.has_mate_downstream());
    /// ```
    pub fn has_mate_downstream(self) -> bool {
        self.contains(Self::HAS_MATE_DOWNSTREAM)
    }

    /// Returns whether the `DECODE_SEQUENCE_AS_UNKNOWN` flag is set.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_cram::record::Flags;
    /// let flags = Flags::DECODE_SEQUENCE_AS_UNKNOWN;
    /// assert!(flags.decode_sequence_as_unknown());
    /// ```
    pub fn decode_sequence_as_unknown(self) -> bool {
        self.contains(Self::DECODE_SEQUENCE_AS_UNKNOWN)
    }
}

impl From<u8> for Flags {
    fn from(value: u8) -> Self {
        Self::from_bits_truncate(value)
    }
}

impl From<Flags> for u8 {
    fn from(flags: Flags) -> Self {
        flags.bits()
    }
}

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

    #[test]
    fn test_default() {
        let flags = Flags::default();

        assert!(flags.is_empty());

        assert!(!flags.are_quality_scores_stored_as_array());
        assert!(!flags.is_detached());
        assert!(!flags.has_mate_downstream());
        assert!(!flags.decode_sequence_as_unknown());
    }

    #[test]
    fn test_contains() {
        assert!(Flags::QUALITY_SCORES_STORED_AS_ARRAY.are_quality_scores_stored_as_array());
        assert!(Flags::DETACHED.is_detached());
        assert!(Flags::HAS_MATE_DOWNSTREAM.has_mate_downstream());
        assert!(Flags::DECODE_SEQUENCE_AS_UNKNOWN.decode_sequence_as_unknown());
    }

    #[test]
    fn test_from_u8_for_flags() {
        assert_eq!(Flags::from(0x01), Flags::QUALITY_SCORES_STORED_AS_ARRAY);
        assert_eq!(Flags::from(0x02), Flags::DETACHED);
        assert_eq!(Flags::from(0x04), Flags::HAS_MATE_DOWNSTREAM);
        assert_eq!(Flags::from(0x08), Flags::DECODE_SEQUENCE_AS_UNKNOWN);
    }

    #[test]
    fn test_from_flags_for_u8() {
        assert_eq!(u8::from(Flags::from(0x01)), 0x01);
        assert_eq!(u8::from(Flags::from(0x02)), 0x02);
        assert_eq!(u8::from(Flags::from(0x04)), 0x04);
        assert_eq!(u8::from(Flags::from(0x08)), 0x08);
    }
}