Struct lsp_types::CompletionItem
source · [−]pub struct CompletionItem {Show 17 fields
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 for this completion item.
Implementations
sourceimpl CompletionItem
impl CompletionItem
sourcepub fn new_simple(label: String, detail: String) -> CompletionItem
pub fn new_simple(label: String, detail: String) -> CompletionItem
Create a CompletionItem with the minimum possible info (label and detail).
Trait Implementations
sourceimpl Clone for CompletionItem
impl Clone for CompletionItem
sourcefn clone(&self) -> CompletionItem
fn clone(&self) -> CompletionItem
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CompletionItem
impl Debug for CompletionItem
sourceimpl Default for CompletionItem
impl Default for CompletionItem
sourcefn default() -> CompletionItem
fn default() -> CompletionItem
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for CompletionItem
impl<'de> Deserialize<'de> for CompletionItem
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<CompletionItem> for CompletionItem
impl PartialEq<CompletionItem> for CompletionItem
sourcefn eq(&self, other: &CompletionItem) -> bool
fn eq(&self, other: &CompletionItem) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CompletionItem) -> bool
fn ne(&self, other: &CompletionItem) -> bool
This method tests for !=
.
sourceimpl Serialize for CompletionItem
impl Serialize for CompletionItem
impl StructuralPartialEq for CompletionItem
Auto Trait Implementations
impl RefUnwindSafe for CompletionItem
impl Send for CompletionItem
impl Sync for CompletionItem
impl Unpin for CompletionItem
impl UnwindSafe for CompletionItem
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more