fgumi 0.1.3

High-performance tools for UMI-tagged sequencing data: extraction, grouping, and consensus calling
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

mod kind;

use std::{error, fmt};

use noodles::sam::alignment::record::cigar::Op;

use self::kind::encode_kind;

const MAX_LENGTH: usize = (1 << 28) - 1;

#[derive(Clone, Debug, Eq, PartialEq)]
pub enum EncodeError {
    InvalidLength(usize),
}

impl error::Error for EncodeError {}

impl fmt::Display for EncodeError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidLength(actual) => {
                write!(f, "invalid length: expected <= {MAX_LENGTH}, got {actual}")
            }
        }
    }
}

#[allow(clippy::cast_possible_truncation)]
pub(super) fn encode_op(op: Op) -> Result<u32, EncodeError> {
    if op.len() <= MAX_LENGTH {
        // SAFETY: `op.len() <= MAX_LENGTH <= u32::MAX`.
        let len = op.len() as u32;
        let k = encode_kind(op.kind());
        Ok((len << 4) | k)
    } else {
        Err(EncodeError::InvalidLength(op.len()))
    }
}

#[cfg(test)]
mod tests {
    use noodles::sam::alignment::record::cigar::op::Kind;

    use super::*;

    #[test]
    fn test_encode_op() {
        assert_eq!(encode_op(Op::new(Kind::Match, 1)), Ok(0x10));

        assert_eq!(
            encode_op(Op::new(Kind::Match, 1 << 28)),
            Err(EncodeError::InvalidLength(1 << 28))
        );
    }
}