Struct Finder

pub struct Finder { /* private fields */ }

Available on crate feature dep_memchr only.

A forward substring searcher using the Shift-Or algorithm.

Implementations

impl Finder

pub fn new(needle: &[u8]) -> Option<Finder>

Create a new Shift-Or forward searcher for the given needle.

The needle may be empty. The empty needle matches at every byte offset.

pub fn find(&self, haystack: &[u8]) -> Option<usize>

Return the first occurrence of the needle given to Finder::new in the haystack given. If no such occurrence exists, then None is returned.

Unlike most other substring search implementations in this crate, this finder does not require passing the needle at search time. A match can be determined without the needle at all since the required information is already encoded into this finder at construction time.

The maximum value this can return is haystack.len(), which can only occur when the needle and haystack both have length zero. Otherwise, for non-empty haystacks, the maximum value is haystack.len() - 1.

Trait Implementations

impl Debug for Finder

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

Formats the value using the given formatter.