nucleobases 0.1.0

Common library for cross crate standardization of nucleobases in code
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
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

use std::marker::Copy;
use std::clone::Clone;
use std::hash::Hash;
use std::convert::TryFrom;

use std::fmt;
use std::cmp;

#[derive(Copy, Clone, cmp::Eq, cmp::PartialEq, cmp::Ord, cmp::PartialOrd, Hash, fmt::Debug)]
pub enum Nucleobase {
    Adenine,
    Cytosine,
    Guanine,
    Thymine,
    Uracil,
}

pub fn is_purine(base: &Nucleobase) -> bool {
    match base {
        Nucleobase::Adenine | Nucleobase::Guanine => true,
        Nucleobase::Cytosine | Nucleobase::Thymine | Nucleobase::Uracil => false,
    }
}

pub fn is_pyrimidine(base: &Nucleobase) -> bool {
    match base {
        Nucleobase::Adenine | Nucleobase::Guanine => false,
        Nucleobase::Cytosine | Nucleobase::Thymine | Nucleobase::Uracil => true,
    }
}

pub fn is_ketone(base: &Nucleobase) -> bool {
    match base {
        Nucleobase::Adenine | Nucleobase::Cytosine => false,
        Nucleobase::Guanine | Nucleobase::Thymine | Nucleobase::Uracil => true,
    }
}

pub fn is_amine(base: &Nucleobase) -> bool {
    match base {
        Nucleobase::Adenine | Nucleobase::Cytosine => true,
        Nucleobase::Guanine | Nucleobase::Thymine | Nucleobase::Uracil => false,
    }
}

pub fn is_ribonucleotide_base(base: &Nucleobase) -> bool {
    match base {
        Nucleobase::Adenine | Nucleobase::Cytosine | Nucleobase::Guanine | Nucleobase::Uracil => true,
        Nucleobase::Thymine => false,
    }
}

pub fn is_deoxyribonucleotide_base(base: &Nucleobase) -> bool {
    match base {
        Nucleobase::Adenine | Nucleobase::Cytosine | Nucleobase::Guanine | Nucleobase::Thymine => true,
        Nucleobase::Uracil => false
    }
}

pub fn to_letter_code(base: &Nucleobase) -> char {
    match base {
        Nucleobase::Adenine => 'A',
        Nucleobase::Cytosine => 'C',
        Nucleobase::Guanine => 'G',
        Nucleobase::Thymine => 'T',
        Nucleobase::Uracil => 'U',
    }
}

pub fn from_letter_code(letter_code: &char) -> Option<Nucleobase> {
    match letter_code {
        'A' | 'a' => Some(Nucleobase::Adenine),
        'C' | 'c' => Some(Nucleobase::Cytosine),
        'G' | 'g' => Some(Nucleobase::Guanine),
        'T' | 't' => Some(Nucleobase::Thymine),
        'U' | 'u' => Some(Nucleobase::Uracil),
        _ => None
    }
}

impl Nucleobase {
    pub fn is_purine(&self) -> bool { is_purine(self) }

    pub fn is_pyrimidine(&self) -> bool { is_pyrimidine(self) }

    pub fn is_ketone(&self) -> bool { is_ketone(self) }

    pub fn is_amine(&self) -> bool { is_amine(self) }

    pub fn is_ribonucleotide_base(&self) -> bool { is_ribonucleotide_base(self) }

    pub fn is_deoxyribonucleotide_base(&self) -> bool { is_deoxyribonucleotide_base(self) }

    pub fn to_letter_code(&self) -> char { to_letter_code(self) }

    pub fn from_letter_code(letter_code: &char) -> Option<Self> { from_letter_code(letter_code) }
}

impl TryFrom<&char> for Nucleobase {
    type Error = &'static str;

    fn try_from(c: &char) -> Result<Self, Self::Error> {
        match from_letter_code(c) {
            Some(base) => Ok(base),
            None => Err("Invalid character code")
        }
    }
}

impl TryFrom<char> for Nucleobase {
    type Error = &'static str;

    fn try_from(c: char) -> Result<Self, Self::Error> { Self::try_from(&c) }
}

impl fmt::Display for Nucleobase {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:?}", self)
    }
}

#[cfg(test)]
mod tests {
    use crate::Nucleobase;

    #[test]
    fn correct_deoxyribonucleotide_bases() {
        assert_eq!(Nucleobase::Adenine.is_deoxyribonucleotide_base(), true);
        assert_eq!(Nucleobase::Cytosine.is_deoxyribonucleotide_base(), true);
        assert_eq!(Nucleobase::Guanine.is_deoxyribonucleotide_base(), true);
        assert_eq!(Nucleobase::Thymine.is_deoxyribonucleotide_base(), true);
        assert_eq!(Nucleobase::Uracil.is_deoxyribonucleotide_base(), false);
    }

    #[test]
    fn correct_ribonucleotide_bases() {
        assert_eq!(Nucleobase::Adenine.is_ribonucleotide_base(), true);
        assert_eq!(Nucleobase::Cytosine.is_ribonucleotide_base(), true);
        assert_eq!(Nucleobase::Guanine.is_ribonucleotide_base(), true);
        assert_eq!(Nucleobase::Thymine.is_ribonucleotide_base(), false);
        assert_eq!(Nucleobase::Uracil.is_ribonucleotide_base(), true);
    }

    #[test]
    fn correct_letter_codes() {
        assert_eq!(crate::from_letter_code(& 'a'), Some(Nucleobase::Adenine));
        assert_eq!(crate::from_letter_code(& 'A'), Some(Nucleobase::Adenine));
        assert_eq!(crate::from_letter_code(& 'c'), Some(Nucleobase::Cytosine));
        assert_eq!(crate::from_letter_code(& 'C'), Some(Nucleobase::Cytosine));
        assert_eq!(crate::from_letter_code(& 'g'), Some(Nucleobase::Guanine));
        assert_eq!(crate::from_letter_code(& 'G'), Some(Nucleobase::Guanine));
        assert_eq!(crate::from_letter_code(& 't'), Some(Nucleobase::Thymine));
        assert_eq!(crate::from_letter_code(& 'T'), Some(Nucleobase::Thymine));
        assert_eq!(crate::from_letter_code(& 'u'), Some(Nucleobase::Uracil));
        assert_eq!(crate::from_letter_code(& 'U'), Some(Nucleobase::Uracil));
        assert_eq!(crate::from_letter_code(& 'n'), None);
    }
}