gen_lsp v0.8.1

View Source GenLSP.Structures.CompletionList (gen_lsp v0.8.1)

Represents a collection of {@link CompletionItem completion items} to be presented in the editor.

Link to this section Summary

Types

t()

Functions

%GenLSP.Structures.CompletionList{}

Fields

  • is_incomplete: This list it not complete. Further typing results in recomputing this list.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %GenLSP.Structures.CompletionList{
  is_incomplete: boolean(),
  item_defaults: map() | nil,
  items: [GenLSP.Structures.CompletionItem.t()]
}

Link to this section Functions

Link to this function

%GenLSP.Structures.CompletionList{}

View Source (struct)

fields

 Fields

  • is_incomplete: This list it not complete. Further typing results in recomputing this list.

    Recomputed lists have all their items replaced (not appended) in the incomplete completion sessions.

  • item_defaults: In many cases the items of an actual completion result share the same value for properties like commitCharacters or the range of a text edit. A completion list can therefore define item defaults which will be used if a completion item itself doesn't specify the value.

    If a completion list specifies a default value and a completion item also specifies a corresponding value the one from the item is used.

    Servers are only allowed to return default values if the client signals support for this via the completionList.itemDefaults capability.

    @since 3.17.0

  • items: The completion items.