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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
//! Provides forward and backward substring searchers that operate on stream.
use crate::buffer::{Buffer, BufferRev};
use memchr::memmem;
use std::io::{self, Read, Seek, SeekFrom};

/// Returns the index of the first occurrence of the given needle in the stream.
pub fn find<R>(needle: &[u8], rdr: &mut R) -> Option<io::Result<usize>>
where
    R: Read,
{
    FindIter::new_with_needle(rdr, needle).next()
}

/// Returns the index of the last occurrence of the given needle in the stream.
pub fn rfind<R>(needle: &[u8], rdr: &mut R) -> Option<io::Result<usize>>
where
    R: Read + Seek,
{
    match FindRevIter::new_with_needle(rdr, needle) {
        Ok(mut iter) => iter.next(),
        Err(e) => Some(Err(e)),
    }
}

/// Returns an iterator over all occurrences of the given needle in the stream.
pub fn find_iter<'n, 's, R>(
    needle: &'n [u8],
    rdr: &'s mut R,
) -> FindIter<'n, 's, R>
where
    R: Read,
{
    FindIter::new_with_needle(rdr, needle)
}

/// Returns a reverse iterator over all occurrences of the given needle in the stream.
///
/// # Errors
///
/// Returns an I/O error if seeking to the end of the stream failed.
///
/// # Panics
///
/// Panics if the length of the stream is greater than `usize::MAX`.
pub fn rfind_iter<'n, 's, R>(
    needle: &'n [u8],
    rdr: &'s mut R,
) -> io::Result<FindRevIter<'n, 's, R>>
where
    R: Read + Seek,
{
    FindRevIter::new_with_needle(rdr, needle)
}

/// A substring searcher for stream searches.
#[derive(Debug)]
pub struct StreamFinder<'n> {
    /// The string we want to search.
    needle: &'n [u8],
}

impl<'n> StreamFinder<'n> {
    /// Creates a new `StreamFinder` for the given needle.
    pub fn new(needle: &'n [u8]) -> StreamFinder<'n> {
        StreamFinder { needle }
    }

    /// Returns the needle that this finder searches for.
    pub fn needle(&self) -> &[u8] {
        self.needle
    }

    /// Returns the index of the first occurrence of the given needle in the stream.
    pub fn find<R: Read>(&self, rdr: &mut R) -> Option<io::Result<usize>> {
        self.find_iter(rdr).next()
    }

    /// Returns the index of the last occurrence of the given needle in the stream.
    ///
    /// # Panics
    ///
    /// Panics if the length of the stream is greater than `usize::MAX`.
    pub fn rfind<R: Read + Seek>(
        &self,
        rdr: &mut R,
    ) -> Option<io::Result<usize>> {
        match self.rfind_iter(rdr) {
            Ok(mut iter) => iter.next(),
            Err(e) => Some(Err(e)),
        }
    }

    /// Returns an iterator over all occurrences of the given needle in the stream.
    pub fn find_iter<'s, R: Read>(
        &'n self,
        rdr: &'s mut R,
    ) -> FindIter<'n, 's, R> {
        FindIter::new(rdr, self)
    }

    /// Returns a reverse iterator over all occurrences of the given needle in the stream.
    ///
    /// # Errors
    ///
    /// Returns an I/O error if seeking to the end of the stream failed.
    ///
    /// # Panics
    ///
    /// Panics if the length of the stream is greater than `usize::MAX`.
    pub fn rfind_iter<'s, R: Read + Seek>(
        &'n self,
        rdr: &'s mut R,
    ) -> io::Result<FindRevIter<'n, 's, R>> {
        FindRevIter::new(rdr, self)
    }
}

/// A forward iterator over all non-overlapping occurrences of a substring in a stream.
///
/// Matches are reported by the byte offset at which they begin.
#[derive(Debug)]
pub struct FindIter<'n, 's, R: Read> {
    /// The stream source we read from.
    rdr: &'s mut R,
    /// The original finder, which contains the needle.
    needle: &'n [u8],
    /// A fixed size buffer that we actually search for. It must be big enough to hold the needle.
    buf: Buffer,
    /// The current position at which to start the next search in `finder.buf`.
    search_pos: usize,
    /// The absolute position of `search_pos` in the stream.
    stream_pos: usize,
    /// The position we report to the caller.
    report_pos: usize,
}

/// A backward iterator over all non-overlapping occurrences of a substring in a stream.
///
/// Matches are reported by the byte offset at which they begin.
#[derive(Debug)]
pub struct FindRevIter<'n, 's, R: Read + Seek> {
    /// The stream source we read from.
    rdr: &'s mut R,
    /// The original finder, which contains the needle.
    needle: &'n [u8],
    /// A fixed size buffer that we actually search for. It must be big enough to hold the needle.
    buf: BufferRev,
    /// The current position at which to start the next search in `finder.buf`.
    search_pos: usize,
    /// The absolute position of `search_pos` in the stream.
    stream_pos: usize,
    /// The position we report to the caller.
    report_pos: usize,
    /// The current seek position.
    seek_pos: usize,
    /// The length of the stream.
    stream_len: usize,
}

impl<'n, 's, R: Read> FindIter<'n, 's, R> {
    pub(crate) fn new(rdr: &'s mut R, fdr: &'n StreamFinder<'n>) -> Self {
        let needle = fdr.needle();
        let buf = Buffer::new(needle.len());
        FindIter {
            rdr,
            needle,
            buf,
            search_pos: 0,
            stream_pos: 0,
            report_pos: 0,
        }
    }

    pub(crate) fn new_with_needle(rdr: &'s mut R, needle: &'n [u8]) -> Self {
        let buf = Buffer::new(needle.len());
        FindIter {
            rdr,
            needle,
            buf,
            search_pos: 0,
            stream_pos: 0,
            report_pos: 0,
        }
    }
}

impl<'n, 's, R: Read + Seek> FindRevIter<'n, 's, R> {
    pub(crate) fn new(
        rdr: &'s mut R,
        fdr: &'n StreamFinder<'n>,
    ) -> io::Result<Self> {
        let stream_len = rdr.seek(SeekFrom::End(0))?;
        assert!(stream_len <= usize::MAX as u64);
        let stream_len = stream_len as usize;

        let needle = fdr.needle();
        let buf = BufferRev::new(needle.len());
        Ok(FindRevIter {
            rdr,
            needle,
            buf,
            search_pos: 0,
            stream_pos: stream_len,
            report_pos: 0,
            seek_pos: stream_len,
            stream_len,
        })
    }

    pub(crate) fn new_with_needle(
        rdr: &'s mut R,
        needle: &'n [u8],
    ) -> io::Result<Self> {
        let stream_len = rdr.seek(SeekFrom::End(0))?;
        assert!(stream_len <= usize::MAX as u64);
        let stream_len = stream_len as usize;

        let buf = BufferRev::new(needle.len());
        Ok(FindRevIter {
            rdr,
            needle,
            buf,
            search_pos: 0,
            stream_pos: stream_len,
            report_pos: 0,
            seek_pos: stream_len,
            stream_len,
        })
    }

    /// Returns the length of the underlying stream.
    pub fn stream_len(&self) -> usize {
        self.stream_len
    }

    /// Moves the curosr of the underlying stream to the given position.
    pub fn seek_to(&mut self, pos: usize) -> io::Result<()> {
        self.rdr.seek(SeekFrom::Start(pos as u64)).map(|_| ())
    }
}

impl<'n, 's, R: Read> Iterator for FindIter<'n, 's, R> {
    type Item = io::Result<usize>;

    fn next(&mut self) -> Option<Self::Item> {
        loop {
            if self.search_pos < self.buf.len() {
                if let Some(mat) = memmem::find(
                    &self.buf.buffer()[self.search_pos..],
                    self.needle,
                ) {
                    self.report_pos = self.stream_pos + mat;
                    self.stream_pos += mat + self.needle.len();
                    self.search_pos += mat + self.needle.len();
                    return Some(Ok(self.report_pos));
                }

                self.stream_pos += self.buf.len() - self.search_pos;
                // self.search_pos = self.buf.len() - self.search_pos;
                self.search_pos = self.buf.len();
            }

            // Roll our buffer if our buffer has at least the minimum amount of bytes in it.
            if self.buf.len() >= self.buf.min_buffer_len() {
                self.stream_pos -= self.buf.min_buffer_len();
                self.search_pos = 0;
                self.buf.roll();
            }
            match self.buf.fill(&mut self.rdr) {
                // report any I/O errors.
                Err(err) => return Some(Err(err)),
                // we've reach EOF, return `None` now.
                Ok(false) => {
                    return None;
                }
                // fallthrough for another search.
                Ok(true) => {}
            }
        }
    }
}

impl<'n, 's, R: Read + Seek> Iterator for FindRevIter<'n, 's, R> {
    type Item = io::Result<usize>;

    fn next(&mut self) -> Option<Self::Item> {
        loop {
            // If the contents of the buffer have not been consumed yet.
            if self.search_pos < self.buf.len() {
                if let Some(mat) = memmem::rfind(
                    &self.buf.buffer()[..self.buf.len() - self.search_pos],
                    self.needle,
                ) {
                    self.report_pos = self.stream_pos
                        - (self.buf.len() - self.search_pos - mat);
                    self.stream_pos -= self.buf.len() - self.search_pos - mat;
                    self.search_pos += self.buf.len() - self.search_pos - mat;

                    return Some(Ok(self.report_pos));
                }

                self.stream_pos = self
                    .stream_pos
                    .saturating_sub(self.buf.len() - self.search_pos);
                self.search_pos = self.buf.len();
            }

            // We have nothing to search if seek position is 0.
            if self.seek_pos == 0 {
                return None;
            }

            // Roll our buffer if our buffer has at least the minimum amount of bytes in it.
            if self.buf.len() >= self.buf.min_buffer_len() {
                // self.stream_pos += self.buf.min_buffer_len();
                self.buf.roll_right();
                self.stream_pos += self.buf.len();
                self.search_pos = 0;
            }

            let free_buffer_len = self.buf.free_buffer().len();
            let amount = if self.stream_pos > free_buffer_len {
                self.seek_pos -= free_buffer_len;
                free_buffer_len
            } else {
                self.seek_pos = 0;
                self.stream_pos
            };
            match self.rdr.seek(SeekFrom::Start(self.seek_pos as u64)) {
                Ok(_) => {}
                Err(e) => return Some(Err(e)),
            }
            match self.buf.fill_exact(&mut self.rdr, amount) {
                // report any I/O errors.
                Err(err) => return Some(Err(err)),
                // we've reach EOF, return `None` now.
                Ok(false) => {
                    return None;
                }
                // fallthrough for another search.
                Ok(true) => {}
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::buffer::DEFAULT_BUFFER_CAPACITY;
    use std::io::Cursor;
    use std::iter::repeat;

    #[test]
    fn test_find_iter_n1s1() {
        let haystack = b"1";
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"1");
        let matches: Vec<usize> =
            finder.find_iter(&mut haystack).map(|x| x.unwrap()).collect();
        let expected: Vec<usize> = vec![0];
        assert_eq!(matches, expected);

        let finder = StreamFinder::new(b"0");
        let matches: Vec<usize> =
            finder.find_iter(&mut haystack).map(|x| x.unwrap()).collect();
        let expected: Vec<usize> = vec![];
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_rev_iter_n1s1() {
        let haystack = b"1";
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"1");
        let matches: Vec<usize> = finder
            .rfind_iter(&mut haystack)
            .unwrap()
            .map(|x| x.unwrap())
            .collect();
        let expected: Vec<usize> = vec![0];
        assert_eq!(matches, expected);

        let finder = StreamFinder::new(b"0");
        let matches: Vec<usize> = finder
            .rfind_iter(&mut haystack)
            .unwrap()
            .map(|x| x.unwrap())
            .collect();
        let expected: Vec<usize> = vec![];
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_iter_n2s1() {
        let haystack = b"1";
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"11");
        let matches: Vec<usize> =
            finder.find_iter(&mut haystack).map(|x| x.unwrap()).collect();
        let expected: Vec<usize> = vec![];
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_rev_iter_n2s1() {
        let haystack = b"1";
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"11");
        let matches: Vec<usize> = finder
            .rfind_iter(&mut haystack)
            .unwrap()
            .map(|x| x.unwrap())
            .collect();
        let expected: Vec<usize> = vec![];
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_iter_n1s21() {
        let haystack = b"11 - 1 - 11  - 1 - 11";
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"1");
        let matches: Vec<usize> =
            finder.find_iter(&mut haystack).map(|x| x.unwrap()).collect();
        let expected: Vec<usize> = vec![0, 1, 5, 9, 10, 15, 19, 20];
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_rev_iter_n1s21() {
        let haystack = b"11 - 1 - 11  - 1 - 11";
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"1");
        let matches: Vec<usize> = finder
            .rfind_iter(&mut haystack)
            .unwrap()
            .map(|x| x.unwrap())
            .collect();
        let expected: Vec<usize> =
            vec![0, 1, 5, 9, 10, 15, 19, 20].into_iter().rev().collect();
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_iter_n1s8213() {
        let haystack: Vec<u8> = repeat(&0u8)
            .take(DEFAULT_BUFFER_CAPACITY)
            .chain("42 0 42 42 0 42".as_bytes())
            .copied()
            .collect();
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"4");
        let matches: Vec<usize> =
            finder.find_iter(&mut haystack).map(|x| x.unwrap()).collect();
        let expected: Vec<usize> = vec![0, 5, 8, 13]
            .into_iter()
            .map(|x| x + DEFAULT_BUFFER_CAPACITY)
            .collect();
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_rev_iter_n1s8213() {
        let haystack: Vec<u8> = repeat(&0u8)
            .take(DEFAULT_BUFFER_CAPACITY)
            .chain("42 0 42 42 0 42".as_bytes())
            .copied()
            .collect();
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"4");
        let matches: Vec<usize> = finder
            .rfind_iter(&mut haystack)
            .unwrap()
            .map(|x| x.unwrap())
            .collect();
        let expected: Vec<usize> = vec![0, 5, 8, 13]
            .into_iter()
            .map(|x| x + DEFAULT_BUFFER_CAPACITY)
            .rev()
            .collect();
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_iter_n2s8213() {
        let haystack: Vec<u8> = repeat(&0u8)
            .take(DEFAULT_BUFFER_CAPACITY)
            .chain("42 0 42 42 0 42".as_bytes())
            .copied()
            .collect();
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"42");
        let matches: Vec<usize> =
            finder.find_iter(&mut haystack).map(|x| x.unwrap()).collect();
        let expected: Vec<usize> = vec![0, 5, 8, 13]
            .into_iter()
            .map(|x| x + DEFAULT_BUFFER_CAPACITY)
            .collect();
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_rev_iter_n2s8213() {
        let haystack: Vec<u8> = repeat(&0u8)
            .take(DEFAULT_BUFFER_CAPACITY)
            .chain("42 0 42 42 0 42".as_bytes())
            .copied()
            .collect();
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"42");
        let matches: Vec<usize> = finder
            .rfind_iter(&mut haystack)
            .unwrap()
            .map(|x| x.unwrap())
            .collect();
        let expected: Vec<usize> = vec![0, 5, 8, 13]
            .into_iter()
            .map(|x| x + DEFAULT_BUFFER_CAPACITY)
            .rev()
            .collect();
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_iter_n2s8212() {
        let haystack: Vec<u8> = repeat(&0u8)
            .take(DEFAULT_BUFFER_CAPACITY - 1)
            .chain("42 0 42 42 0 42".as_bytes())
            .copied()
            .collect();
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"42");
        let matches: Vec<usize> =
            finder.find_iter(&mut haystack).map(|x| x.unwrap()).collect();
        let expected: Vec<usize> = vec![0, 5, 8, 13]
            .into_iter()
            .map(|x| x + DEFAULT_BUFFER_CAPACITY - 1)
            .collect();
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_rev_iter_n2s8212() {
        let haystack: Vec<u8> = repeat(&0u8)
            .take(DEFAULT_BUFFER_CAPACITY - 1)
            .chain("42 0 42 42 0 42".as_bytes())
            .copied()
            .collect();
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"42");
        let matches: Vec<usize> = finder
            .rfind_iter(&mut haystack)
            .unwrap()
            .map(|x| x.unwrap())
            .collect();
        let expected: Vec<usize> = vec![0, 5, 8, 13]
            .into_iter()
            .map(|x| x + DEFAULT_BUFFER_CAPACITY - 1)
            .rev()
            .collect();
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_iter_n3s8212() {
        let haystack: Vec<u8> = repeat(&0u8)
            .take(DEFAULT_BUFFER_CAPACITY - 1)
            .chain("42 0 42 42 0 42".as_bytes())
            .copied()
            .collect();
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"42 ");
        let matches: Vec<usize> =
            finder.find_iter(&mut haystack).map(|x| x.unwrap()).collect();
        let expected: Vec<usize> = vec![0, 5, 8]
            .into_iter()
            .map(|x| x + DEFAULT_BUFFER_CAPACITY - 1)
            .collect();
        assert_eq!(matches, expected);
    }

    #[test]
    fn test_find_rev_iter_n3s8212() {
        let haystack: Vec<u8> = repeat(&0u8)
            .take(DEFAULT_BUFFER_CAPACITY - 1)
            .chain("42 0 42 42 0 42".as_bytes())
            .copied()
            .collect();
        let mut haystack = Cursor::new(haystack);

        let finder = StreamFinder::new(b"42 ");
        let matches: Vec<usize> = finder
            .rfind_iter(&mut haystack)
            .unwrap()
            .map(|x| x.unwrap())
            .collect();
        let expected: Vec<usize> = vec![0, 5, 8]
            .into_iter()
            .map(|x| x + DEFAULT_BUFFER_CAPACITY - 1)
            .rev()
            .collect();
        assert_eq!(matches, expected);
    }
}