Struct FinderBuilder

pub struct FinderBuilder { /* private fields */ }

Available on crate feature dep_memchr only.

A builder for constructing non-default forward or reverse memmem finders.

A builder is primarily useful for configuring a substring searcher. Currently, the only configuration exposed is the ability to disable heuristic prefilters used to speed up certain searches.

Implementations

impl FinderBuilder

pub fn new() -> FinderBuilder

Create a new finder builder with default settings.

pub fn build_forward<'n, B>(&self, needle: &'n B) -> Finder<'n>

where B: AsRef<[u8]> + ?Sized,

Build a forward finder using the given needle from the current settings.

pub fn build_forward_with_ranker<'n, R, B>( &self, ranker: R, needle: &'n B, ) -> Finder<'n>

where R: HeuristicFrequencyRank, B: AsRef<[u8]> + ?Sized,

Build a forward finder using the given needle and a custom heuristic for determining the frequency of a given byte in the dataset. See HeuristicFrequencyRank for more details.

pub fn build_reverse<'n, B>(&self, needle: &'n B) -> FinderRev<'n>

where B: AsRef<[u8]> + ?Sized,

Build a reverse finder using the given needle from the current settings.

pub fn prefilter(&mut self, prefilter: PrefilterConfig) -> &mut FinderBuilder

Configure the prefilter setting for the finder.

See the documentation for Prefilter for more discussion on why you might want to configure this.

Trait Implementations

impl Clone for FinderBuilder

fn clone(&self) -> FinderBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FinderBuilder

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

Formats the value using the given formatter.

impl Default for FinderBuilder

fn default() -> FinderBuilder

Returns the “default value” for a type.