Struct FieldWeight 

pub struct FieldWeight(/* private fields */);

The share of MAX_FIELD_RANK a match in one field is worth, in percent.

Implementations

impl FieldWeight

pub const TITLE: FieldWeight

The name a person looks for: a title, a contact’s name, a file name.

pub const KEYWORD: FieldWeight

A word the person uses for the thing without it being its name: an alias, a synonym, the product it stands in for (“youtube” for a video app), the same in another language. Ranks below the name and above identities; its words also match by typo.

pub const IDENTITY: FieldWeight

A stable identity the person may type verbatim: an id, a path, a key.

pub const SUBTITLE: FieldWeight

A secondary line shown with the hit: an author, a sender, a folder.

pub const METADATA: FieldWeight

Other short fields: labels, tags, addresses.

pub const BODY: FieldWeight

Long prose: a message body, a chapter, a note.

pub const UNRANKED: FieldWeight

Searchable, but never reorders hits.

pub const fn new(percent: u8) -> FieldWeight

A custom weight; values above 100 are clamped. An index keeps one field per weight in [INDEXED_WEIGHTS]; a custom weight ranks as the nearest of them.

pub const fn percent(self) -> u8

Trait Implementations

impl Clone for FieldWeight

fn clone(&self) -> FieldWeight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldWeight

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

Formats the value using the given formatter.

impl Hash for FieldWeight

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FieldWeight

fn cmp(&self, other: &FieldWeight) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FieldWeight

fn eq(&self, other: &FieldWeight) -> 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 PartialOrd for FieldWeight

fn partial_cmp(&self, other: &FieldWeight) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for FieldWeight

impl Eq for FieldWeight

impl StructuralPartialEq for FieldWeight