Current section

Files

Jump to
gen_lsp lib gen_lsp protocol structures completion_params.ex
Raw

lib/gen_lsp/protocol/structures/completion_params.ex

# codegen: do not edit
defmodule GenLSP.Structures.CompletionParams do
@moduledoc """
Completion parameters
"""
import Schematic, warn: false
use TypedStruct
@doc """
## Fields
* context: The completion context. This is only available it the client specifies
to send this using the client capability `textDocument.completion.contextSupport === true`
* work_done_token: An optional token that a server can use to report work done progress.
* partial_result_token: An optional token that a server can use to report partial results (e.g. streaming) to
the client.
* text_document: The text document.
* position: The position inside the text document.
"""
@derive Jason.Encoder
typedstruct do
field :context, GenLSP.Structures.CompletionContext.t()
field :work_done_token, GenLSP.TypeAlias.ProgressToken.t()
field :partial_result_token, GenLSP.TypeAlias.ProgressToken.t()
field :text_document, GenLSP.Structures.TextDocumentIdentifier.t(), enforce: true
field :position, GenLSP.Structures.Position.t(), enforce: true
end
@doc false
@spec schematic() :: Schematic.t()
def schematic() do
schema(__MODULE__, %{
{"context", :context} => oneof([null(), GenLSP.Structures.CompletionContext.schematic()]),
{"workDoneToken", :work_done_token} =>
oneof([null(), GenLSP.TypeAlias.ProgressToken.schematic()]),
{"partialResultToken", :partial_result_token} =>
oneof([null(), GenLSP.TypeAlias.ProgressToken.schematic()]),
{"textDocument", :text_document} => GenLSP.Structures.TextDocumentIdentifier.schematic(),
{"position", :position} => GenLSP.Structures.Position.schematic()
})
end
end