zoe 0.0.31

A nightly library for viral genomics
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

use crate::data::err::GetCode;
use std::{error::Error, fmt};

/// An enum representing errors that can happen when working with pHMMs.
#[non_exhaustive]
#[derive(Eq, PartialEq)]
pub enum PhmmError {
    /// An error caused by an invalid model
    InvalidModel(InvalidModelError),
    /// No alignment with nonzero probability can be found with the pHMM
    NoAlignmentFound,
    /// An invalid path through a pHMM was specified
    InvalidPath,
    /// Invalid CIGAR string
    InvalidCigar,
    ///  Unsupported CIGAR opcode used in argument
    InvalidCigarOp(u8),
}

impl fmt::Display for PhmmError {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            PhmmError::InvalidModel(_) => write!(f, "The pHMM model is invalid!"),
            PhmmError::NoAlignmentFound => write!(f, "No alignment with nonzero probability found!"),
            PhmmError::InvalidPath => write!(f, "The path specified is not valid for the given pHMM!"),
            PhmmError::InvalidCigar => write!(f, "The CIGAR string was invalid!"),
            PhmmError::InvalidCigarOp(op) => {
                write!(f, "An unsupported CIGAR operation was encountered: {op}", op = *op as char)
            }
        }
    }
}

impl fmt::Debug for PhmmError {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{self}")
    }
}

impl Error for PhmmError {
    #[inline]
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            PhmmError::InvalidModel(invalid_model_error) => Some(invalid_model_error),
            _ => None,
        }
    }
}

impl GetCode for PhmmError {}

impl From<InvalidModelError> for PhmmError {
    #[inline]
    fn from(value: InvalidModelError) -> Self {
        PhmmError::InvalidModel(value)
    }
}

/// An enum representing errors that can happen when working with pHMMs.
#[non_exhaustive]
#[derive(Copy, Clone, Eq, PartialEq)]
pub enum InvalidModelError {
    /// The model has no layers
    EmptyModel,
    /// Not enough layers were specified
    TooFewLayers(usize),
    /// Alignment modules were incompatible with core pHMM
    IncompatibleModule,
}

impl fmt::Display for InvalidModelError {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            InvalidModelError::EmptyModel => write!(f, "No layers were present in the pHMM!"),
            InvalidModelError::TooFewLayers(num) => {
                write!(f, "Too few layers were specified for the pHMM! At least {num} are required")
            }
            InvalidModelError::IncompatibleModule => {
                write!(f, "The pHMM's alignment modules are incompatible with the core pHMM!")
            }
        }
    }
}

impl fmt::Debug for InvalidModelError {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{self}")
    }
}

impl Error for InvalidModelError {}
impl GetCode for InvalidModelError {}