Struct ra_ap_ide::CompletionRelevance

pub struct CompletionRelevance {
    pub exact_name_match: bool,
    pub type_match: Option<CompletionRelevanceTypeMatch>,
    pub is_local: bool,
    pub is_op_method: bool,
    pub is_private_editable: bool,
    pub exact_postfix_snippet_match: bool,
}

Fields

exact_name_match: bool

This is set in cases like these:

fn f(spam: String) {}
fn main {
    let spam = 92;
    f($0) // name of local matches the name of param
}

type_match: Option<CompletionRelevanceTypeMatch>

See CompletionRelevanceTypeMatch doc comments for cases where this is set.

is_local: bool

This is set in cases like these:

fn foo(a: u32) {
    let b = 0;
    $0 // `a` and `b` are local
}

is_op_method: bool

Set for method completions of the core::ops and core::cmp family.

is_private_editable: bool

Set for item completions that are private but in the workspace.

exact_postfix_snippet_match: bool

This is set in cases like these:

(a > b).not$0

Basically, we want to guarantee that postfix snippets always takes precedence over everything else.

Implementations

impl CompletionRelevance

pub fn score(&self) -> u32

Provides a relevance score. Higher values are more relevant.

The absolute value of the relevance score is not meaningful, for example a value of 0 doesn’t mean “not relevant”, rather it means “least relevant”. The score value should only be used for relative ordering.

See is_relevant if you need to make some judgement about score in an absolute sense.

pub fn is_relevant(&self) -> bool

Returns true when the score for this threshold is above some threshold such that we think it is especially likely to be relevant.

Trait Implementations

impl Clone for CompletionRelevance

pub fn clone(&self) -> CompletionRelevance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionRelevance

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

Formats the value using the given formatter.

impl Default for CompletionRelevance

pub fn default() -> CompletionRelevance

Returns the “default value” for a type.

impl PartialEq<CompletionRelevance> for CompletionRelevance

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for CompletionRelevance

impl Eq for CompletionRelevance

impl StructuralEq for CompletionRelevance

impl StructuralPartialEq for CompletionRelevance