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.

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

Returns the needle that this finder searches for.

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.

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.

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.

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.

Trait Implementations

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

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

Formats the value using the given formatter.