Struct CompletionCandidate 

pub struct CompletionCandidate {
    pub label: String,
    pub insert_text: Option<String>,
    pub detail: Option<String>,
    pub icon: Option<String>,
    pub score: i64,
    pub source: Option<CompletionSourceId>,
    pub is_snippet: bool,
    pub provider_data: Option<String>,
}

A single completion candidate produced by a provider.

Fields

label: String

The text to display in the completion popup.

insert_text: Option<String>

The text to insert when the completion is accepted. If None, label is used as the insert text.

detail: Option<String>

Optional detail shown alongside the label (e.g., type info).

icon: Option<String>

Icon hint for the popup (e.g., “v” for variable, “λ” for function).

score: i64

Provider-assigned relevance score. Higher is better. Used by the CompletionService to merge and rank results from multiple providers.

source: Option<CompletionSourceId>

Which provider produced this candidate. Set automatically by the service; providers should leave this as None.

is_snippet: bool

If true, the insert_text contains LSP-style snippet syntax ($0, ${1:placeholder}, etc.).

provider_data: Option<String>

Opaque provider-specific data carried through to acceptance. For example, the LSP provider stores the serialised CompletionItem so it can request completionItem/resolve on accept.

Implementations

impl CompletionCandidate

pub fn word(label: String, score: i64) -> Self

Create a simple word candidate (no snippet, no extra data).

Trait Implementations

impl Clone for CompletionCandidate

fn clone(&self) -> CompletionCandidate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionCandidate

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

Formats the value using the given formatter.