bit-string 0.2.0

A compact owned bit string type with editing, matching, and bitwise operations.
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

use super::*;

#[inline]
fn bits_equal_at(haystack: &BitString, offset: usize, needle: &BitString) -> bool {
    for index in 0..needle.len {
        if haystack.get(offset + index).unwrap() != needle.get(index).unwrap() {
            return false;
        }
    }

    true
}

impl BitString {
    pub fn matches_at(&self, index: usize, pattern: &Self) -> bool {
        if index > self.len {
            return false;
        }

        if pattern.len > self.len - index {
            return false;
        }

        bits_equal_at(self, index, pattern)
    }

    #[inline]
    pub fn starts_with(&self, prefix: &Self) -> bool {
        self.matches_at(0, prefix)
    }

    #[inline]
    pub fn ends_with(&self, suffix: &Self) -> bool {
        suffix.len <= self.len && self.matches_at(self.len - suffix.len, suffix)
    }

    #[inline]
    pub fn contains_bits(&self, needle: &Self) -> bool {
        self.find_bits(needle).is_some()
    }

    pub fn find_bits(&self, needle: &Self) -> Option<usize> {
        if needle.len == 0 {
            return Some(0);
        }

        if needle.len > self.len {
            return None;
        }

        let last_start = self.len - needle.len;

        (0..=last_start).find(|&index| bits_equal_at(self, index, needle))
    }

    pub fn rfind_bits(&self, needle: &Self) -> Option<usize> {
        if needle.len == 0 {
            return Some(self.len);
        }

        if needle.len > self.len {
            return None;
        }

        let last_start = self.len - needle.len;

        (0..=last_start)
            .rev()
            .find(|&index| bits_equal_at(self, index, needle))
    }

    pub fn strip_prefix(&self, prefix: &Self) -> Option<Self> {
        self.starts_with(prefix)
            .then(|| self.slice_from(prefix.len))
    }

    pub fn strip_suffix(&self, suffix: &Self) -> Option<Self> {
        self.ends_with(suffix)
            .then(|| self.slice_until(self.len - suffix.len))
    }
}

#[cfg(test)]
mod tests_for_bits_equal_at;

#[cfg(test)]
mod tests_for_matches_at;

#[cfg(test)]
mod tests_for_starts_with;

#[cfg(test)]
mod tests_for_ends_with;

#[cfg(test)]
mod tests_for_contains_bits;

#[cfg(test)]
mod tests_for_find_bits;

#[cfg(test)]
mod tests_for_rfind_bits;

#[cfg(test)]
mod tests_for_strip_prefix;

#[cfg(test)]
mod tests_for_strip_suffix;