Struct sublime_fuzzy::Scoring

pub struct Scoring {
    pub bonus_consecutive: isize,
    pub bonus_word_start: isize,
    pub bonus_match_case: isize,
    pub penalty_distance: isize,
}

Bonuses/penalties used for scoring a Match.

Fields

bonus_consecutive: isize

current_consecutive_count * bonus_consecutive will be added for every consecutive char match.

1 * bonus for the first consecutive match, 2 * bonus for the second, etc.

bonus_word_start: isize

Added when a query char matches a word start.

bonus_match_case: isize

Added when the matched query char also matches the case of the target char.

Only applied if the search is case insensitive.

penalty_distance: isize

Subtracted from the score for every char between two matches.

Implementations

impl Scoring

pub fn new(
    bonus_consecutive: isize,
    bonus_word_start: isize,
    bonus_match_case: isize,
    penalty_distance: isize
) -> Self

Creates a new configuration with the given bonuses/penalties.

pub fn emphasize_word_starts() -> Self

Creates a configuration that emphasizes matching word starts (this is also the default).

pub fn emphasize_distance() -> Self

Creates a configuration that emphasizes short distances between matched chars.

Trait Implementations

impl Clone for Scoring

pub fn clone(&self) -> Scoring

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scoring

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

Formats the value using the given formatter.

impl Default for Scoring

pub fn default() -> Self

Creates a default configuration, see Scoring::emphasize_word_starts.