Struct Config

#[non_exhaustive]
pub struct Config {
    pub normalize: bool,
    pub ignore_case: bool,
    pub prefer_prefix: bool,
    /* private fields */
}

Configuration data that controls how a matcher behaves

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

normalize: bool

Whether to normalize latin script characters to ASCII (enabled by default)

ignore_case: bool

whether to ignore casing

prefer_prefix: bool

Whether to provide a bonus to matches by their distance from the start of the haystack. The bonus is fairly small compared to the normal gap penalty to avoid messing with the normal score heuristic. This setting is not turned on by default and only recommended for autocompletion usecases where the expectation is that the user is typing the entire match. For a full fzf-like fuzzy matcher/picker word segmentation and explicit prefix literals should be used instead.

Implementations

impl Config

pub const DEFAULT: Self

The default config for nucleo, implemented as a constant since Default::default can not be called in a const context

impl Config

pub fn set_match_paths(&mut self)

Configures the matcher with bonuses appropriate for matching file paths.

pub const fn match_paths(self) -> Self

Configures the matcher with bonuses appropriate for matching file paths.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Config

impl StructuralPartialEq for Config