Struct FuzzySearch

pub struct FuzzySearch<'a> { /* private fields */ }

Describes a fuzzy search. Alternative to best_match which allows for more configuration.

Examples

Basic usage:

use sublime_fuzzy::{FuzzySearch, Scoring};

let scoring = Scoring::emphasize_word_starts();

let result = FuzzySearch::new("something", "Some Search Thing")
    .score_with(&scoring)
    .case_insensitive()
    .best_match();

assert!(result.is_some());

Implementations

impl<'a> FuzzySearch<'a>

pub fn new(query: &'a str, target: &'a str) -> Self

Creates a new search to match query in target.

Note that whitespace in query will be ignored.

pub fn score_with(self, scoring: &'a Scoring) -> Self

Use custom scoring values.

If not specified will use Scoring::default().

pub fn case_sensitive(self) -> Self

Only match query chars in the target string if case matches.

Scoring::bonus_match_case will not be applied if this is set (because a char match will always also be a case match).

pub fn case_insensitive(self) -> Self

Ignore case when matching query chars in the target string.

If not only the char but also the case matches, Scoring::bonus_match_case will be added to the score. If that behavior is not wanted the bonus can be set to 0 with custom scoring.

pub fn best_match(self) -> Option<Match>

Finds the best match of the query in the target string.

Always tries to match the full pattern. A partial match is considered invalid and will return None. Will also return None in case the query or target string are empty.