diced 0.1.3

A Rust reimplementation of the MinCED algorithm for identifying CRISPRs in full or assembled genomes.
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

use std::ops::Deref;
use std::ops::Range;

use super::Crispr;

#[derive(Debug, Clone, PartialEq)]
pub enum RegionType {
    Spacer,
    Repeat,
}

/// A sequence region.
#[derive(Debug)]
pub struct Region<S> {
    sequence: S,
    start: usize,
    end: usize,
}

impl<S> Region<S> {
    #[inline]
    pub fn new(sequence: S, start: usize, end: usize) -> Self {
        Self {
            sequence,
            start,
            end,
        }
    }

    #[inline]
    pub fn is_empty(&self) -> bool {
        self.start == self.end
    }

    #[inline]
    pub fn len(&self) -> usize {
        self.end - self.start
    }

    #[inline]
    pub fn start(&self) -> usize {
        self.start
    }

    #[inline]
    pub fn end(&self) -> usize {
        self.end
    }
}

impl<S: AsRef<str>> Region<S> {
    #[inline]
    pub fn as_str(&self) -> &str {
        self.as_ref()
    }

    #[inline]
    pub fn as_bytes(&self) -> &[u8] {
        self.as_ref().as_bytes()
    }
}

impl<S: AsRef<str>> AsRef<str> for Region<S> {
    #[inline]
    fn as_ref(&self) -> &str {
        &self.sequence.as_ref()[self.start..self.end]
    }
}

impl<S: AsRef<str>> Deref for Region<S> {
    type Target = str;
    #[inline]
    fn deref(&self) -> &Self::Target {
        self.as_ref()
    }
}

impl<S: AsRef<str>> PartialEq<&str> for Region<S> {
    #[inline]
    fn eq(&self, other: &&str) -> bool {
        self.as_ref() == *other
    }
}

/// An iterator over arbitrary sequence regions.
#[derive(Debug)]
pub struct Regions<'c, S> {
    indices: Range<usize>,
    crispr: &'c Crispr<S>,
    ty: RegionType,
}

impl<'c, S: AsRef<str> + Clone> Regions<'c, S> {
    pub(crate) fn new(crispr: &'c Crispr<S>, ty: RegionType) -> Self {
        Self {
            indices: 0..crispr.len(),
            crispr,
            ty,
        }
    }

    #[inline]
    fn get(&self, i: usize) -> Region<S> {
        match self.ty {
            RegionType::Spacer => self.crispr.spacer(i),
            RegionType::Repeat => self.crispr.repeat(i),
        }
    }
}

impl<'c, S: AsRef<str> + Clone> Iterator for Regions<'c, S> {
    type Item = Region<S>;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        self.indices.next().map(|index| self.get(index))
    }

    #[inline]
    fn nth(&mut self, n: usize) -> Option<Self::Item> {
        self.indices.nth(n).map(|index| self.get(index))
    }
}

impl<'c, S: AsRef<str> + Clone> DoubleEndedIterator for Regions<'c, S> {
    #[inline]
    fn next_back(&mut self) -> Option<Self::Item> {
        self.indices.next_back().map(|index| self.get(index))
    }

    #[inline]
    fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
        self.indices.nth_back(n).map(|index| self.get(index))
    }
}

impl<'c, S: AsRef<str> + Clone> ExactSizeIterator for Regions<'c, S> {
    #[inline]
    fn len(&self) -> usize {
        self.indices.len()
    }
}