Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub max_typos: Option<u16>,
    pub casing: CaseMatching,
    pub unicode: UnicodeMatching,
    pub matching: Matching,
    pub sort: SortStrategy,
    pub scoring: Scoring,
}

Fields§

§max_typos: Option<u16>

The maximum number of characters missing from the needle, before an item in the haystack is filtered out

§casing: CaseMatching

Controls how case sensitivity/insensitivity is handled while matching

§unicode: UnicodeMatching

Controls how unicode is handled while matching

§matching: Matching

Selects the matching algorithm: fuzzy (Smith-Waterman) or one of the literal modes (exact, prefix, suffix, substring). Literal modes require the needle to appear as a contiguous run of characters and do not support typos (max_typos is ignored).

§sort: SortStrategy

Controls how results are ordered

§scoring: Scoring

Controls the scoring used by the smith waterman algorithm. Pay close attention to the documentation for each property, as small changes can lead to poor matching.

Implementations§

Source§

impl Config

Source

pub fn matching(self, matching: Matching) -> Self

Sets the matching mode

Source

pub fn max_typos(self, max_typos: Option<u16>) -> Self

Sets the maximum number of typos allowed

Source

pub fn casing(self, casing: CaseMatching) -> Self

Sets the casing mode

Source

pub fn unicode(self, unicode: UnicodeMatching) -> Self

Sets the unicode mode

Source

pub fn sort(self, sort: SortStrategy) -> Self

Sets how results are ordered

Source

pub fn scoring(self, scoring: Scoring) -> Self

Sets the scoring

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Config

Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Config

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Config

Source§

impl PartialEq for Config

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Config

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.