Struct CompletionItem 

#[non_exhaustive]
pub struct CompletionItem {
    pub label: String,
    pub kind: CompletionKind,
    pub detail: Option<String>,
    pub doc: Option<String>,
    pub insert: InsertText,
    pub replace: Option<Range<u32>>,
    pub sort_key: String,
    pub retrigger: bool,
}

One structured completion item. #[non_exhaustive] with a new() + with_* builder chain, so adding a field never breaks an app that builds these: construct with CompletionItem::new, then layer on optional detail/doc/replace/sort-key/retrigger.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

label: String

The text shown in the popup row (and the default filter/insert text).

kind: CompletionKind

The item’s category (drives the row icon/color).

detail: Option<String>

Short type/shape hint, rendered right-aligned in the popup row.

doc: Option<String>

Plain-text documentation, rendered as a plain block in the popup; markdown rendering lives in the hover popup, not here.

insert: InsertText

What accepting the item inserts (plain text or a snippet).

replace: Option<Range<u32>>

Absolute byte range to replace; None = the word range recomputed live at accept time (the word may have grown since the request).

sort_key: String

Tier prefix + label, sorted lexicographically: 0_ params (required before optional), 1_ symbols, 2_ constructs, 3_ keywords. Defaults to the label when not set explicitly.

retrigger: bool

When set, accepting the item fires exactly one Manual re-request after the transaction commits (e.g. param= reopens the popup in value position).

Implementations

impl CompletionItem

pub fn new( label: impl Into<String>, kind: CompletionKind, insert: InsertText, ) -> Self

A minimal item: label, kind, and insertion. sort_key defaults to the label; detail/doc/replace default absent; retrigger false.

pub fn plain(label: impl Into<String>, kind: CompletionKind) -> Self

Convenience: a plain-text item whose insertion equals its label.

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

Set the right-aligned type/shape hint.

pub fn with_doc(self, doc: impl Into<String>) -> Self

Set the plain-text documentation block.

pub fn with_replace(self, replace: Range<u32>) -> Self

Override the replace range (default = the live word range at accept time).

pub fn with_sort_key(self, sort_key: impl Into<String>) -> Self

Set the sort key (tier prefix + label); defaults to the label.

pub fn with_retrigger(self, retrigger: bool) -> Self

Mark the item to fire one Manual re-request after acceptance commits.

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

Formats the value using the given formatter.