Struct xfind::StreamFinder

pub struct StreamFinder<'n> { /* fields omitted */ }

A substring searcher for stream searches.

Implementations

impl<'n> StreamFinder<'n>

pub fn new(needle: &'n [u8]) -> StreamFinder<'n>

Creates a new StreamFinder for the given needle.

Examples

use xfind::StreamFinder;

let finder = StreamFinder::new(b"rust");

pub fn needle(&self) -> &[u8]

Returns the needle that this finder searches for.

Examples

use xfind::StreamFinder;

let finder = StreamFinder::new(b"rust");
assert_eq!(finder.needle(), b"rust");

pub fn find<R: Read>(&self, rdr: &mut R) -> Option<Result<usize>>

Returns the index of the first occurrence of the given needle in the stream.

Examples

use std::io::{self, Cursor};
use xfind::StreamFinder;

fn main() -> io::Result<()> {
    let mut stream = Cursor::new(b"rusty rust");
    let finder = StreamFinder::new(b"rust");

    let pos = finder.find(&mut stream).transpose()?;
    assert_eq!(pos, Some(0));

    Ok(())
}

pub fn rfind<R: Read + Seek>(&self, rdr: &mut R) -> Option<Result<usize>>

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.

Examples

use std::io::{self, Cursor};
use xfind::StreamFinder;

fn main() -> io::Result<()> {
    let mut stream = Cursor::new(b"rusty rust");
    let finder = StreamFinder::new(b"rust");

    let pos = finder.rfind(&mut stream).transpose()?;
    assert_eq!(pos, Some(6));

    Ok(())
}

pub fn find_iter<'s, R: Read>(&'n self, rdr: &'s mut R) -> FindIter<'n, 's, R>

Returns an iterator over all occurrences of the given needle in the stream.

Examples

use std::io::{self, Cursor};
use xfind::StreamFinder;

fn main() -> io::Result<()> {
    let mut stream = Cursor::new(b"rusty rust");
    let finder = StreamFinder::new(b"rust");

    let mut iter = finder.find_iter(&mut stream);
    assert_eq!(iter.next().transpose()?, Some(0));
    assert_eq!(iter.next().transpose()?, Some(6));
    assert_eq!(iter.next().transpose()?, None);

    Ok(())
}

pub fn rfind_iter<'s, R: Read + Seek>(
    &'n self,
    rdr: &'s mut R
) -> Result<FindRevIter<'n, 's, R>>

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.

Examples

use std::io::{self, Cursor};
use xfind::StreamFinder;

fn main() -> io::Result<()> {
    let mut stream = Cursor::new(b"rusty rust");
    let finder = StreamFinder::new(b"rust");

    let mut iter = finder.rfind_iter(&mut stream)?;
    assert_eq!(iter.next().transpose()?, Some(6));
    assert_eq!(iter.next().transpose()?, Some(0));
    assert_eq!(iter.next().transpose()?, None);

    Ok(())
}

Trait Implementations

impl<'n> Clone for StreamFinder<'n>

fn clone(&self) -> StreamFinder<'n>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'n> Debug for StreamFinder<'n>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.