Struct ide::CompletionRelevance

pub struct CompletionRelevance {
    pub exact_name_match: bool,
    pub type_match: Option<CompletionRelevanceTypeMatch>,
    pub is_local: bool,
    pub is_item_from_trait: bool,
    pub is_item_from_notable_trait: bool,
    pub is_name_already_imported: bool,
    pub requires_import: bool,
    pub is_op_method: bool,
    pub is_private_editable: bool,
    pub postfix_match: Option<CompletionRelevancePostfixMatch>,
    pub is_definite: bool,
    pub function: Option<CompletionRelevanceFn>,
}

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_item_from_trait: bool

This is set when trait items are completed in an impl of that trait.

is_item_from_notable_trait: bool

This is set for when trait items are from traits with #[doc(notable_trait)]

is_name_already_imported: bool

This is set when an import is suggested whose name is already imported.

requires_import: bool

This is set for completions that will insert a use item.

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.

postfix_match: Option<CompletionRelevancePostfixMatch>

Set for postfix snippet item completions

is_definite: bool

This is set for type inference results

function: Option<CompletionRelevanceFn>

This is set for items that are function (associated or method)

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

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

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

Formats the value using the given formatter.

impl Default for CompletionRelevance

fn default() -> CompletionRelevance

Returns the “default value” for a type.

impl PartialEq for CompletionRelevance

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

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

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

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

impl Copy for CompletionRelevance

impl Eq for CompletionRelevance

impl StructuralPartialEq for CompletionRelevance