Struct lsp_types::CompletionItem

pub struct CompletionItem {

    pub label: String,
    pub kind: Option<CompletionItemKind>,
    pub detail: Option<String>,
    pub documentation: Option<Documentation>,
    pub deprecated: Option<bool>,
    pub preselect: Option<bool>,
    pub sort_text: Option<String>,
    pub filter_text: Option<String>,
    pub insert_text: Option<String>,
    pub insert_text_format: Option<InsertTextFormat>,
    pub insert_text_mode: Option<InsertTextMode>,
    pub text_edit: Option<CompletionTextEdit>,
    pub additional_text_edits: Option<Vec<TextEdit>>,
    pub command: Option<Command>,
    pub commit_characters: Option<Vec<String>>,
    pub data: Option<Value>,
    pub tags: Option<Vec<CompletionItemTag>>,
}

Fields

label: String

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

kind: Option<CompletionItemKind>

The kind of this completion item. Based of the kind an icon is chosen by the editor.

detail: Option<String>

A human-readable string with additional information about this item, like type or symbol information.

documentation: Option<Documentation>

A human-readable string that represents a doc-comment.

deprecated: Option<bool>

Indicates if this item is deprecated.

preselect: Option<bool>

Select this item when showing.

sort_text: Option<String>

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

filter_text: Option<String>

A string that should be used when filtering a set of completion items. When falsy the label is used as the filter text for this item.

insert_text: Option<String>

A string that should be inserted into a document when selecting this completion. When falsy the label is used as the insert text for this item.

The insertText is subject to interpretation by the client side. Some tools might not take the string literally. For example VS Code when code complete is requested in this example con<cursor position> and a completion item with an insertText of console is provided it will only insert sole. Therefore it is recommended to use textEdit instead since it avoids additional client side interpretation.

insert_text_format: Option<InsertTextFormat>

The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit. If omitted defaults to InsertTextFormat.PlainText.

@since 3.16.0

insert_text_mode: Option<InsertTextMode>

How whitespace and indentation is handled during completion item insertion. If not provided the client’s default value is used.

@since 3.16.0

text_edit: Option<CompletionTextEdit>

An edit which is applied to a document when selecting this completion. When an edit is provided the value of insertText is ignored.

Most editors support two different operation when accepting a completion item. One is to insert a completion text and the other is to replace an existing text with a completion text. Since this can usually not predetermined by a server it can report both ranges. Clients need to signal support for InsertReplaceEdits via the textDocument.completion.insertReplaceSupport client capability property.

Note 1: The text edit’s range as well as both ranges from a insert replace edit must be a [single line] and they must contain the position at which completion has been requested. Note 2: If an InsertReplaceEdit is returned the edit’s insert range must be a prefix of the edit’s replace range, that means it must be contained and starting at the same position.

@since 3.16.0 additional type InsertReplaceEdit

additional_text_edits: Option<Vec<TextEdit>>

An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap with the main edit nor with themselves.

command: Option<Command>

An optional command that is executed after inserting this completion. Note that additional modifications to the current document should be described with the additionalTextEdits-property.

commit_characters: Option<Vec<String>>

An optional set of characters that when pressed while this completion is active will accept it first and then type that character. Note that all commit characters should have length=1 and that superfluous characters will be ignored.

data: Option<Value>

An data entry field that is preserved on a completion item between a completion and a completion resolve request.

tags: Option<Vec<CompletionItemTag>>

Tags for this completion item.

Implementations

impl CompletionItem

pub fn new_simple(label: String, detail: String) -> CompletionItem

Create a CompletionItem with the minimum possible info (label and detail).

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 Default for CompletionItem

fn default() -> CompletionItem

Returns the “default value” for a type.

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<CompletionItem> for CompletionItem

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

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

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

This method tests for !=.

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 StructuralPartialEq for CompletionItem