ppatch 0.1.0

A library to search/replace binary data via patterns
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

use crate::{Pattern, PatternSearchType, Searcher};
use std::fmt;
use std::iter::Iterator;
use std::ops;

pub struct PatternSearchRefIterator<'a, I, T> {
    iter: I,
    searcher: Searcher<'a, T>,
}

impl<'a, I, T> PatternSearchRefIterator<'a, I, T>
where
    I: Iterator,
    T: From<u8>
        + fmt::Binary
        + num::PrimInt
        + num::Unsigned
        + Default
        + ops::ShlAssign<u32>
        + PartialEq
        + num::PrimInt<FromStrRadixErr = std::num::ParseIntError>
        + ops::BitOrAssign
        + ops::BitAndAssign,
{
    pub fn new(iter: I, pattern: &'a Pattern<T>) -> Self {
        Self {
            iter,
            searcher: Searcher::new(pattern),
        }
    }
}

impl<'a, 'b, I, T> Iterator for PatternSearchRefIterator<'a, I, T>
where
    'a: 'b,
    I: Iterator<Item = &'b T>,
    T: From<u8>
        + fmt::Binary
        + num::PrimInt
        + num::Unsigned
        + Default
        + ops::ShlAssign<u32>
        + PartialEq
        + num::PrimInt<FromStrRadixErr = std::num::ParseIntError>
        + ops::BitOrAssign
        + ops::BitAndAssign,
{
    type Item = PatternSearchType<T>;

    fn next(&mut self) -> Option<Self::Item> {
        if let Some(result) = self.searcher.handle_existing_data() {
            return Some(result);
        }

        while let Some(byte) = self.iter.next() {
            if let Some(result) = self.searcher.handle_next(*byte) {
                return Some(result);
            }
        }

        self.searcher.handle_existing_data()
    }
}

pub trait PatternSearchRefExt<'a, 'b, T>: Iterator<Item = &'b T> + Sized
where
    T: 'b
        + From<u8>
        + fmt::Binary
        + num::PrimInt
        + num::Unsigned
        + Default
        + ops::ShlAssign<u32>
        + PartialEq
        + num::PrimInt<FromStrRadixErr = std::num::ParseIntError>
        + ops::BitOrAssign
        + ops::BitAndAssign,
{
    fn search_pattern(self, pattern: &'a Pattern<T>) -> PatternSearchRefIterator<'a, Self, T>;
}

impl<'a, 'b, I, T> PatternSearchRefExt<'a, 'b, T> for I
where
    I: Iterator<Item = &'b T>,
    T: 'b
        + From<u8>
        + fmt::Binary
        + num::PrimInt
        + num::Unsigned
        + Default
        + ops::ShlAssign<u32>
        + PartialEq
        + num::PrimInt<FromStrRadixErr = std::num::ParseIntError>
        + ops::BitOrAssign
        + ops::BitAndAssign,
{
    fn search_pattern(self, pattern: &'a Pattern<T>) -> PatternSearchRefIterator<'a, Self, T> {
        PatternSearchRefIterator::new(self, pattern)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::str::FromStr;

    #[test]
    fn search_global() {
        let d = [0x1a, 0x2b, 0x3c, 0x4d, 0x5e, 0x6f];
        let s = Pattern::<u8>::from_str("0b???0???? 0b???1????").unwrap();
        let mut iter = d.iter().search_pattern(&s);
        assert_eq!(Some(PatternSearchType::NonMatch(0x1a)), iter.next());
        assert_eq!(
            Some(PatternSearchType::Match {
                data: [0x2b, 0x3c].to_vec(),
                index: 1
            }),
            iter.next()
        );
        assert_eq!(
            Some(PatternSearchType::Match {
                data: [0x4d, 0x5e].to_vec(),
                index: 3
            }),
            iter.next()
        );
        // partial match before end
        assert_eq!(Some(PatternSearchType::NonMatch(0x6f)), iter.next());
        assert_eq!(None, iter.next());
    }
}