Struct CompletionItem 

pub struct CompletionItem {
    pub insert_text: String,
    pub label: String,
    pub detail: Option<String>,
    pub documentation: Option<String>,
    pub source: &'static str,
    pub kind: CompletionKind,
    pub sort_priority: u32,
    pub filter_text: Option<String>,
    pub score: u32,
    pub match_indices: Vec<u32>,
}

A completion item returned by a completion provider

Fields

insert_text: String

Text to insert when this item is selected

label: String

Display label shown in the completion menu

detail: Option<String>

Optional detail text (e.g., type info, signature)

documentation: Option<String>

Optional documentation for preview

source: &'static str

Source identifier (e.g., “buffer”, “lsp”, “path”)

kind: CompletionKind

Kind of completion for icon/styling

sort_priority: u32

Sort priority (lower = higher priority)

filter_text: Option<String>

Custom filter text (defaults to label if None)

score: u32

Score from fuzzy matching (set by completion engine)

match_indices: Vec<u32>

Indices of matched characters in filter_text (for highlighting)

Implementations

impl CompletionItem

pub fn new( insert_text: impl Into<String>, source: &'static str, ) -> CompletionItem

Create a new completion item with minimal data

pub fn with_label(self, label: impl Into<String>) -> CompletionItem

Set custom label

pub fn with_detail(self, detail: impl Into<String>) -> CompletionItem

Set detail text

pub fn with_documentation(self, doc: impl Into<String>) -> CompletionItem

Set documentation

pub const fn with_kind(self, kind: CompletionKind) -> CompletionItem

Set completion kind

pub const fn with_priority(self, priority: u32) -> CompletionItem

Set sort priority

pub fn with_filter_text(self, text: impl Into<String>) -> CompletionItem

Set filter text

pub fn filter_text(&self) -> &str

Get the text to use for filtering

Trait Implementations

impl Clone for CompletionItem

fn clone(&self) -> CompletionItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionItem

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

Formats the value using the given formatter.