rsvart 0.1.5

A small library for representing genomic variants and regions.
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

use crate::SvartError;
use std::convert::TryFrom;

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum Strand {
    Forward,
    Reverse,
}

impl Strand {
    pub fn is_forward(&self) -> bool {
        *self == Strand::Forward
    }

    pub fn is_reverse(&self) -> bool {
        *self == Strand::Reverse
    }

    pub fn opposite(&self) -> Strand {
        match *self {
            Strand::Reverse => Strand::Forward,
            Strand::Forward => Strand::Reverse,
        }
    }
}

impl TryFrom<char> for Strand {
    type Error = SvartError;

    fn try_from(value: char) -> Result<Self, Self::Error> {
        match value {
            '+' => Ok(Strand::Forward),
            '-' => Ok(Strand::Reverse),
            _ => Err(SvartError::IllegalValueError(
                "Could not parse value for strand.",
            )),
        }
    }
}

impl TryFrom<&str> for Strand {
    type Error = SvartError;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        match value.to_uppercase().as_str() {
            "POS" | "POSITIVE" | "FWD" | "FORWARD" => Ok(Strand::Forward),
            "NEG" | "NEGATIVE" | "REV" | "REVERSE" => Ok(Strand::Reverse),
            _ => Err(SvartError::IllegalValueError(
                "Could not parse value for strand.",
            )),
        }
    }
}

impl std::fmt::Display for Strand {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match *self {
            Strand::Forward => write!(f, "+"),
            Strand::Reverse => write!(f, "-"),
        }
    }
}

#[cfg(test)]
mod test {
    use super::Strand;
    use crate::SvartError;
    use rstest::rstest;
    use std::convert::TryFrom;

    #[rstest]
    #[case(Strand::Forward, true)]
    #[case(Strand::Reverse, false)]
    fn test_is_positive(#[case] input: Strand, #[case] expected: bool) {
        assert_eq!(input.is_forward(), expected);
    }

    #[rstest]
    #[case(Strand::Reverse, true)]
    #[case(Strand::Forward, false)]
    fn test_is_negative(#[case] input: Strand, #[case] expected: bool) {
        assert_eq!(input.is_reverse(), expected);
    }

    #[rstest]
    #[case(Strand::Reverse, "-")]
    #[case(Strand::Forward, "+")]
    fn test_correct_symbol(#[case] input: Strand, #[case] expected: String) {
        assert_eq!(format!("{}", input), expected)
    }

    #[rstest]
    #[case('-', Strand::Reverse)]
    #[case('+', Strand::Forward)]
    fn test_correct_strand_char_pass(#[case] input: char, #[case] expected: Strand) {
        assert_eq!(Strand::try_from(input).unwrap(), expected);
    }

    #[rstest]
    #[case(
        ":",
        SvartError::IllegalValueError("Could not parse value for strand.")
    )]
    fn test_correct_strand_char_fail(#[case] input: char, #[case] expected: SvartError) {
        assert_eq!(Strand::try_from(input).unwrap_err(), expected);
    }

    #[rstest]
    #[case("pos", Strand::Forward)]
    #[case("neg", Strand::Reverse)]
    #[case("positive", Strand::Forward)]
    #[case("negative", Strand::Reverse)]
    fn test_correct_strand_string_pass(#[case] input: &str, #[case] expected: Strand) {
        assert_eq!(Strand::try_from(input).unwrap(), expected);
    }

    #[rstest]
    #[case(
        "notaastrand",
        SvartError::IllegalValueError("Could not parse value for strand.")
    )]
    fn test_correct_strand_string_fail(#[case] input: &str, #[case] expected: SvartError) {
        assert_eq!(Strand::try_from(input).unwrap_err(), expected);
    }

    #[rstest]
    #[case(Strand::Reverse, Strand::Forward)]
    #[case(Strand::Forward, Strand::Reverse)]
    fn test_opposite_strand(#[case] input: Strand, #[case] expected: Strand) {
        assert_eq!(input.opposite(), expected)
    }
}