Struct SearchKey 

pub struct SearchKey {
    pub text: String,
    pub kind: KeyKind,
    pub weight: i32,
    pub case_fold_only: bool,
    pub source_map: Option<Box<[Option<SourceSpan>]>>,
}

One searchable form for a candidate.

Fields

text: String

Text that the matcher scores against query variants.

kind: KeyKind

Semantic key type used for query compatibility checks.

weight: i32

Score adjustment for this key type.

case_fold_only: bool

True when case folding alone reproduces this key from the candidate’s display text, which makes the key redundant for a case-insensitive search whose matcher folds case the same way (see crate::MatcherBackend::folds_case). A matcher that does not claim to fold case is still offered the key.

source_map: Option<Box<[Option<SourceSpan>]>>

Optional map from key character positions back to original source spans.

Implementations

impl SearchKey

pub fn new(kind: KeyKind, text: impl Into<String>) -> Self

Creates a search key using the default weight for its kind.

pub fn default_weight(kind: KeyKind) -> i32

Returns the default score adjustment for a key kind.

pub fn with_case_fold_only(self, case_fold_only: bool) -> Self

Marks whether case folding alone reproduces this key from the display text.

pub fn with_source_map(self, source_map: Vec<Option<SourceSpan>>) -> Self

Attaches a source map to this key.

pub fn original(text: impl Into<String>) -> Self

Creates an original-display search key.

pub fn normalized(text: impl Into<String>) -> Self

Creates a normalized-display search key.

pub fn kana_reading(text: impl Into<String>) -> Self

Creates a Japanese kana-reading search key.

pub fn romaji_reading(text: impl Into<String>) -> Self

Creates a Japanese romaji-reading search key.

pub fn pinyin_full(text: impl Into<String>) -> Self

Creates a Chinese pinyin search key with separated syllables.

pub fn pinyin_joined(text: impl Into<String>) -> Self

Creates a Chinese pinyin search key with syllables joined.

pub fn pinyin_initials(text: impl Into<String>) -> Self

Creates a Chinese pinyin initials search key.

pub fn korean_romanized(text: impl Into<String>) -> Self

Creates a Korean romanized Hangul search key.

pub fn korean_initials(text: impl Into<String>) -> Self

Creates a Korean initial-consonant search key.

pub fn korean_keyboard(text: impl Into<String>) -> Self

Creates a Korean keyboard-layout search key.

pub fn learned_alias(text: impl Into<String>) -> Self

Creates a user-learned alias search key.

Trait Implementations

impl Clone for SearchKey

fn clone(&self) -> SearchKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchKey

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

Formats the value using the given formatter.

impl Eq for SearchKey

impl PartialEq for SearchKey

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SearchKey