Struct broot::fuzzy_patterns::FuzzyPattern

pub struct FuzzyPattern { /* fields omitted */ }

Methods

impl FuzzyPattern

pub fn from(pat: &str) -> FuzzyPattern

build a pattern which will later be usable for fuzzy search. A pattern should be reused

pub fn find(&self, candidate: &str) -> Option<Match>

return a match if the pattern can be found in the candidate string. The algorithm tries to return the best one. For example if you search "abc" in "ababca-abc", the returned match would be at the end.

pub fn score_of(&self, candidate: &str) -> Option<i32>

compute the score of the best match, in a way mostly similar to find but much faster by

• working on bytes instead of chars
• not storing match positions The result is about the same, but the values are often a little different (because lengths of parts are in bytes instead of chars). The test module cares of ensuring the results are the same when all chars are one byte (i.e. there's no big bug) and that orderings are consistent (what matters for the app is scores orderings).

pub const fn optimal_result_number(&self, targeted_size: usize) -> usize

return the number of results we should find before starting to sort them (unless time is runing out).

Trait Implementations

impl Clone for FuzzyPattern

fn clone(&self) -> FuzzyPattern

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FuzzyPattern

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

Formats the value using the given formatter.

impl Display for FuzzyPattern

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

Formats the value using the given formatter.