Struct CompletionItem

pub struct CompletionItem {
    pub label: String,
    pub text: Option<String>,
    pub sort_text: Option<String>,
    pub type_: Option<CompletionItemType>,
    pub start: Option<i32>,
    pub length: i32,
    pub selection_start: Option<i32>,
    pub selection_length: i32,
    /* private fields */
}

CompletionItems are the suggestions returned from the CompletionsRequest.

Fields

label: String

The label of this completion item. By default this is also the text that is inserted when selecting this completion.

text: Option<String>

If text is not falsy then it is inserted instead of the label.

sort_text: Option<String>

A string that should be used when comparing this item with other items. When falsy the label is used.

type_: Option<CompletionItemType>

The item’s type. Typically the client uses this information to render the item in the UI with an icon.

start: Option<i32>

This value determines the location (in the CompletionsRequest’s ‘text’ attribute) where the completion text is added.

If missing the text is added at the location specified by the CompletionsRequest’s ‘column’ attribute.

length: i32

This value determines how many characters are overwritten by the completion text.

If missing the value 0 is assumed which results in the completion text being inserted.

selection_start: Option<i32>

Determines the start of the new selection after the text has been inserted (or replaced).

The start position must in the range 0 and length of the completion text.

If omitted the selection starts at the end of the completion text.

selection_length: i32

Determines the length of the new selection after the text has been inserted (or replaced).

The selection can not extend beyond the bounds of the completion text.

If omitted the length is assumed to be 0.

Implementations

impl CompletionItem

pub fn builder() -> CompletionItemBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building CompletionItem. On the builder, call .label(...), .text(...)(optional), .sort_text(...)(optional), .type_(...)(optional), .start(...)(optional), .length(...)(optional), .selection_start(...)(optional), .selection_length(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CompletionItem.

Trait Implementations

impl Clone for CompletionItem

fn clone(&self) -> CompletionItem

Returns a copy 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.

impl<'de> Deserialize<'de> for CompletionItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CompletionItem

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CompletionItem

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CompletionItem

impl StructuralPartialEq for CompletionItem