7 releases (breaking)

Uses old Rust 2015

0.7.0 Dec 19, 2020
0.6.0 Dec 7, 2018
0.5.0 Mar 24, 2018
0.4.1 Aug 17, 2017
0.2.0 Jul 25, 2017

#270 in Text processing

Download history 15963/week @ 2024-11-08 12975/week @ 2024-11-15 13140/week @ 2024-11-22 14018/week @ 2024-11-29 16927/week @ 2024-12-06 14399/week @ 2024-12-13 7283/week @ 2024-12-20 6303/week @ 2024-12-27 12913/week @ 2025-01-03 13648/week @ 2025-01-10 10456/week @ 2025-01-17 9426/week @ 2025-01-24 10712/week @ 2025-01-31 9796/week @ 2025-02-07 4999/week @ 2025-02-14

27,362 downloads per month
Used in 59 crates (22 directly)

Custom license

37KB
787 lines

sublime_fuzzy sublime_fuzzy on crates.io

Fuzzy matching algorithm based on Sublime Text's string search. Iterates through characters of a search string and calculates a score.

The score is based on several factors:

  • Word starts like the t in some_thing get a bonus (bonus_word_start)
  • Consecutive matches get an accumulative bonus for every consecutive match (bonus_consecutive)
  • Matches that also match case (T -> T instead of t -> T) in case of a case-insensitive search get a bonus (bonus_match_case)
  • The distance between two matches will be multiplied with the penalty_distance penalty and subtracted from the score

The default scoring is configured to give a lot of weight to word starts. So a pattern scc will match SoccerCartoonController, not SoccerCartoonController.

Match Examples

With default weighting.

Pattern Target string Result
scc SoccerCartoonController SoccerCartoonController
something some search thing some search thing

Usage

Basic usage:

use sublime_fuzzy::best_match;

let result = best_match("something", "some search thing");

assert!(result.is_some());

Match::continuous_matches returns an iter of consecutive matches. Based on those the input string can be formatted.

format_simple provides a simple formatting that wraps matches in tags:

use sublime_fuzzy::{best_match, format_simple};

let target = "some search thing";

let result = best_match("something", target).unwrap();

assert_eq!(
    format_simple(&result, target, "<span>", "</span>"),
    "<span>some</span> search <span>thing</span>"
);

The weighting of the different factors can be adjusted:

use sublime_fuzzy::{FuzzySearch, Scoring};

// Or pick from one of the provided `Scoring::...` methods like `emphasize_word_starts`
let scoring = Scoring {
    bonus_consecutive: 128,
    bonus_word_start: 0,
    ..Scoring::default()
};

let result = FuzzySearch::new("something", "some search thing")
    .case_sensitive()
    .score_with(&scoring)
    .best_match();

assert!(result.is_some())

Note: Any whitespace in the pattern ('something' in the examples above) will be removed.

Documentation

Check out the documentation at docs.rs.

Dependencies

~155KB