Crate lspt

Source
Expand description

§lspt

Types of Language Server Protocol.

§Proposed Types

To use proposed types, enable the proposed feature. This is disabled by default.

§URI Implementation

By default, this library uses String as URI. If this doesn’t satisfy your requirements, enable the url feature and it will switch to url::Url.

§Hashmap Implementation

By default, this library uses std::collections::HashMap as hashmap implementation.

You can enable the rustc-hash feature for faster hashing, or enable the indexmap feature for preserve the order in map. Or, enable both of them.

Modules§

notification
request

Structs§

AnnotatedTextEdit
A special text edit with an additional change annotation.
ApplyWorkspaceEditParams
The parameters passed via an apply workspace edit request.
ApplyWorkspaceEditResult
The result returned from the apply workspace edit request.
BaseSymbolInformation
A base for all symbol information.
CallHierarchyClientCapabilities
@since 3.16.0
CallHierarchyIncomingCall
Represents an incoming call, e.g. a caller of a method or constructor.
CallHierarchyIncomingCallsParams
The parameter of a callHierarchy/incomingCalls request.
CallHierarchyItem
Represents programming constructs like functions or constructors in the context of call hierarchy.
CallHierarchyOptions
Call hierarchy options used during static registration.
CallHierarchyOutgoingCall
Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
CallHierarchyOutgoingCallsParams
The parameter of a callHierarchy/outgoingCalls request.
CallHierarchyPrepareParams
The parameter of a textDocument/prepareCallHierarchy request.
CallHierarchyRegistrationOptions
Call hierarchy options used during static or dynamic registration.
CancelParams
ChangeAnnotation
Additional information that describes document changes.
ChangeAnnotationsSupportOptions
@since 3.18.0
ClientCapabilities
Defines the capabilities provided by the client.
ClientCodeActionKindOptions
@since 3.18.0
ClientCodeActionLiteralOptions
@since 3.18.0
ClientCodeActionResolveOptions
@since 3.18.0
ClientCodeLensResolveOptions
@since 3.18.0
ClientCompletionItemInsertTextModeOptions
@since 3.18.0
ClientCompletionItemOptions
@since 3.18.0
ClientCompletionItemOptionsKind
@since 3.18.0
ClientCompletionItemResolveOptions
@since 3.18.0
ClientDiagnosticsTagOptions
@since 3.18.0
ClientFoldingRangeKindOptions
@since 3.18.0
ClientFoldingRangeOptions
@since 3.18.0
ClientInfo
Information about the client
ClientInlayHintResolveOptions
@since 3.18.0
ClientSemanticTokensRequestFullDelta
@since 3.18.0
ClientSemanticTokensRequestOptions
@since 3.18.0
ClientShowMessageActionItemOptions
@since 3.18.0
ClientSignatureInformationOptions
@since 3.18.0
ClientSignatureParameterInformationOptions
@since 3.18.0
ClientSymbolKindOptions
@since 3.18.0
ClientSymbolResolveOptions
@since 3.18.0
ClientSymbolTagOptions
@since 3.18.0
CodeAction
A code action represents a change that can be performed in code, e.g. to fix a problem or to refactor code.
CodeActionClientCapabilities
The Client Capabilities of a {@link CodeActionRequest}.
CodeActionContext
Contains additional diagnostic information about the context in which a {@link CodeActionProvider.provideCodeActions code action} is run.
CodeActionDisabled
Captures why the code action is currently disabled.
CodeActionKindDocumentation
Documentation for a class of code actions.
CodeActionOptions
Provider options for a {@link CodeActionRequest}.
CodeActionParams
The parameters of a {@link CodeActionRequest}.
CodeActionRegistrationOptions
Registration options for a {@link CodeActionRequest}.
CodeActionTagOptions
@since 3.18.0 - proposed
CodeDescription
Structure to capture a description for an error code.
CodeLens
A code lens represents a {@link Command command} that should be shown along with source text, like the number of references, a way to run tests, etc.
CodeLensClientCapabilities
The client capabilities of a {@link CodeLensRequest}.
CodeLensOptions
Code Lens provider options of a {@link CodeLensRequest}.
CodeLensParams
The parameters of a {@link CodeLensRequest}.
CodeLensRegistrationOptions
Registration options for a {@link CodeLensRequest}.
CodeLensWorkspaceClientCapabilities
@since 3.16.0
Color
Represents a color in RGBA space.
ColorInformation
Represents a color range from a document.
ColorPresentation
ColorPresentationParams
Parameters for a {@link ColorPresentationRequest}.
Command
Represents a reference to a command. Provides a title which will be used to represent a command in the UI and, optionally, an array of arguments which will be passed to the command handler function when invoked.
CompletionClientCapabilities
Completion client capabilities
CompletionContext
Contains additional information about the context in which a completion request is triggered.
CompletionItem
A completion item represents a text snippet that is proposed to complete text that is being typed.
CompletionItemApplyKinds
Specifies how fields from a completion item should be combined with those from completionList.itemDefaults.
CompletionItemDefaults
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.
CompletionItemLabelDetails
Additional details for a completion item label.
CompletionItemTagOptions
@since 3.18.0
CompletionList
Represents a collection of {@link CompletionItem completion items} to be presented in the editor.
CompletionListCapabilities
The client supports the following CompletionList specific capabilities.
CompletionOptions
Completion options.
CompletionParams
Completion parameters
CompletionRegistrationOptions
Registration options for a {@link CompletionRequest}.
ConfigurationItem
ConfigurationParams
The parameters of a configuration request.
CreateFile
Create file operation.
CreateFileOptions
Options to create a file.
CreateFilesParams
The parameters sent in notifications/requests for user-initiated creation of files.
DeclarationClientCapabilities
@since 3.14.0
DeclarationOptions
DeclarationParams
DeclarationRegistrationOptions
DefinitionClientCapabilities
Client Capabilities for a {@link DefinitionRequest}.
DefinitionOptions
Server Capabilities for a {@link DefinitionRequest}.
DefinitionParams
Parameters for a {@link DefinitionRequest}.
DefinitionRegistrationOptions
Registration options for a {@link DefinitionRequest}.
DeleteFile
Delete file operation
DeleteFileOptions
Delete file options
DeleteFilesParams
The parameters sent in notifications/requests for user-initiated deletes of files.
Diagnostic
Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.
DiagnosticClientCapabilities
Client capabilities specific to diagnostic pull requests.
DiagnosticOptions
Diagnostic options.
DiagnosticRegistrationOptions
Diagnostic registration options.
DiagnosticRelatedInformation
Represents a related message and source code location for a diagnostic. This should be used to point to code locations that cause or related to a diagnostics, e.g when duplicating a symbol in a scope.
DiagnosticServerCancellationData
Cancellation data returned from a diagnostic request.
DiagnosticWorkspaceClientCapabilities
Workspace client capabilities specific to diagnostic pull requests.
DiagnosticsCapabilities
General diagnostics capabilities for pull and push model.
DidChangeConfigurationClientCapabilities
DidChangeConfigurationParams
The parameters of a change configuration notification.
DidChangeConfigurationRegistrationOptions
DidChangeNotebookDocumentParams
The params sent in a change notebook document notification.
DidChangeTextDocumentParams
The change text document notification’s parameters.
DidChangeWatchedFilesClientCapabilities
DidChangeWatchedFilesParams
The watched files change notification’s parameters.
DidChangeWatchedFilesRegistrationOptions
Describe options to be used when registered for text document change events.
DidChangeWorkspaceFoldersParams
The parameters of a workspace/didChangeWorkspaceFolders notification.
DidCloseNotebookDocumentParams
The params sent in a close notebook document notification.
DidCloseTextDocumentParams
The parameters sent in a close text document notification
DidOpenNotebookDocumentParams
The params sent in an open notebook document notification.
DidOpenTextDocumentParams
The parameters sent in an open text document notification
DidSaveNotebookDocumentParams
The params sent in a save notebook document notification.
DidSaveTextDocumentParams
The parameters sent in a save text document notification
DocumentColorClientCapabilities
DocumentColorOptions
DocumentColorParams
Parameters for a {@link DocumentColorRequest}.
DocumentColorRegistrationOptions
DocumentDiagnosticParams
Parameters of the document diagnostic request.
DocumentDiagnosticReportPartialResult
A partial result for a document diagnostic report.
DocumentFormattingClientCapabilities
Client capabilities of a {@link DocumentFormattingRequest}.
DocumentFormattingOptions
Provider options for a {@link DocumentFormattingRequest}.
DocumentFormattingParams
The parameters of a {@link DocumentFormattingRequest}.
DocumentFormattingRegistrationOptions
Registration options for a {@link DocumentFormattingRequest}.
DocumentHighlight
A document highlight is a range inside a text document which deserves special attention. Usually a document highlight is visualized by changing the background color of its range.
DocumentHighlightClientCapabilities
Client Capabilities for a {@link DocumentHighlightRequest}.
DocumentHighlightOptions
Provider options for a {@link DocumentHighlightRequest}.
DocumentHighlightParams
Parameters for a {@link DocumentHighlightRequest}.
DocumentHighlightRegistrationOptions
Registration options for a {@link DocumentHighlightRequest}.
DocumentLink
A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.
DocumentLinkClientCapabilities
The client capabilities of a {@link DocumentLinkRequest}.
DocumentLinkOptions
Provider options for a {@link DocumentLinkRequest}.
DocumentLinkParams
The parameters of a {@link DocumentLinkRequest}.
DocumentLinkRegistrationOptions
Registration options for a {@link DocumentLinkRequest}.
DocumentOnTypeFormattingClientCapabilities
Client capabilities of a {@link DocumentOnTypeFormattingRequest}.
DocumentOnTypeFormattingOptions
Provider options for a {@link DocumentOnTypeFormattingRequest}.
DocumentOnTypeFormattingParams
The parameters of a {@link DocumentOnTypeFormattingRequest}.
DocumentOnTypeFormattingRegistrationOptions
Registration options for a {@link DocumentOnTypeFormattingRequest}.
DocumentRangeFormattingClientCapabilities
Client capabilities of a {@link DocumentRangeFormattingRequest}.
DocumentRangeFormattingOptions
Provider options for a {@link DocumentRangeFormattingRequest}.
DocumentRangeFormattingParams
The parameters of a {@link DocumentRangeFormattingRequest}.
DocumentRangeFormattingRegistrationOptions
Registration options for a {@link DocumentRangeFormattingRequest}.
DocumentRangesFormattingParams
The parameters of a {@link DocumentRangesFormattingRequest}.
DocumentSymbol
Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g. the range of an identifier.
DocumentSymbolClientCapabilities
Client Capabilities for a {@link DocumentSymbolRequest}.
DocumentSymbolOptions
Provider options for a {@link DocumentSymbolRequest}.
DocumentSymbolParams
Parameters for a {@link DocumentSymbolRequest}.
DocumentSymbolRegistrationOptions
Registration options for a {@link DocumentSymbolRequest}.
EditRangeWithInsertReplace
Edit range variant that includes ranges for insert and replace operations.
ExecuteCommandClientCapabilities
The client capabilities of a {@link ExecuteCommandRequest}.
ExecuteCommandOptions
The server capabilities of a {@link ExecuteCommandRequest}.
ExecuteCommandParams
The parameters of a {@link ExecuteCommandRequest}.
ExecuteCommandRegistrationOptions
Registration options for a {@link ExecuteCommandRequest}.
ExecutionSummary
FileCreate
Represents information on a file/folder create.
FileDelete
Represents information on a file/folder delete.
FileEvent
An event describing a file change.
FileOperationClientCapabilities
Capabilities relating to events from file operations by the user in the client.
FileOperationFilter
A filter to describe in which file operation requests or notifications the server is interested in receiving.
FileOperationOptions
Options for notifications/requests for user operations on files.
FileOperationPattern
A pattern to describe in which file operation requests or notifications the server is interested in receiving.
FileOperationPatternOptions
Matching options for the file operation pattern.
FileOperationRegistrationOptions
The options to register for file operations.
FileRename
Represents information on a file/folder rename.
FileSystemWatcher
FoldingRange
Represents a folding range. To be valid, start and end line must be bigger than zero and smaller than the number of lines in the document. Clients are free to ignore invalid ranges.
FoldingRangeClientCapabilities
FoldingRangeOptions
FoldingRangeParams
Parameters for a {@link FoldingRangeRequest}.
FoldingRangeRegistrationOptions
FoldingRangeWorkspaceClientCapabilities
Client workspace capabilities specific to folding ranges
FormattingOptions
Value-object describing what options formatting should use.
FullDocumentDiagnosticReport
A diagnostic report with a full set of problems.
GeneralClientCapabilities
General client capabilities.
Hover
The result of a hover request.
HoverClientCapabilities
HoverOptions
Hover options.
HoverParams
Parameters for a {@link HoverRequest}.
HoverRegistrationOptions
Registration options for a {@link HoverRequest}.
ImplementationClientCapabilities
@since 3.6.0
ImplementationOptions
ImplementationParams
ImplementationRegistrationOptions
InitializeError
The data type of the ResponseError if the initialize request fails.
InitializeParams
InitializeResult
The result returned from an initialize request.
InitializedParams
InlayHint
Inlay hint information.
InlayHintClientCapabilities
Inlay hint client capabilities.
InlayHintLabelPart
An inlay hint label part allows for interactive and composite labels of inlay hints.
InlayHintOptions
Inlay hint options used during static registration.
InlayHintParams
A parameter literal used in inlay hint requests.
InlayHintRegistrationOptions
Inlay hint options used during static or dynamic registration.
InlayHintWorkspaceClientCapabilities
Client workspace capabilities specific to inlay hints.
InlineCompletionClientCapabilities
Client capabilities specific to inline completions.
InlineCompletionContext
Provides information about the context in which an inline completion was requested.
InlineCompletionItem
An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
InlineCompletionList
Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.
InlineCompletionOptions
Inline completion options used during static registration.
InlineCompletionParams
A parameter literal used in inline completion requests.
InlineCompletionRegistrationOptions
Inline completion options used during static or dynamic registration.
InlineValueClientCapabilities
Client capabilities specific to inline values.
InlineValueContext
@since 3.17.0
InlineValueEvaluatableExpression
Provide an inline value through an expression evaluation. If only a range is specified, the expression will be extracted from the underlying document. An optional expression can be used to override the extracted expression.
InlineValueOptions
Inline value options used during static registration.
InlineValueParams
A parameter literal used in inline value requests.
InlineValueRegistrationOptions
Inline value options used during static or dynamic registration.
InlineValueText
Provide inline value as text.
InlineValueVariableLookup
Provide inline value through a variable lookup. If only a range is specified, the variable name will be extracted from the underlying document. An optional variable name can be used to override the extracted name.
InlineValueWorkspaceClientCapabilities
Client workspace capabilities specific to inline values.
InsertReplaceEdit
A special text edit to provide an insert and a replace operation.
LinkedEditingRangeClientCapabilities
Client capabilities for the linked editing range request.
LinkedEditingRangeOptions
LinkedEditingRangeParams
LinkedEditingRangeRegistrationOptions
LinkedEditingRanges
The result of a linked editing range request.
Location
Represents a location inside a resource, such as a line inside a text file.
LocationLink
Represents the connection of two locations. Provides additional metadata over normal {@link Location locations}, including an origin range.
LocationUriOnly
Location with only uri and does not include range.
LogMessageParams
The log message parameters.
LogTraceParams
MarkdownClientCapabilities
Client capabilities specific to the used markdown parser.
MarkedStringWithLanguageDeprecated
@since 3.18.0 @deprecated use MarkupContent instead.
MarkupContent
A MarkupContent literal represents a string value which content is interpreted base on its kind flag. Currently the protocol supports plaintext and markdown as markup kinds.
MessageActionItem
Moniker
Moniker definition to match LSIF 0.5 moniker definition.
MonikerClientCapabilities
Client capabilities specific to the moniker request.
MonikerOptions
MonikerParams
MonikerRegistrationOptions
NotebookCell
A notebook cell.
NotebookCellArrayChange
A change describing how to move a NotebookCell array from state S to S’.
NotebookCellLanguage
@since 3.18.0
NotebookCellTextDocumentFilter
A notebook cell text document filter denotes a cell text document by different properties.
NotebookDocument
A notebook document.
NotebookDocumentCellChangeStructure
Structural changes to cells in a notebook document.
NotebookDocumentCellChanges
Cell changes to a notebook document.
NotebookDocumentCellContentChanges
Content changes to a cell in a notebook document.
NotebookDocumentChangeEvent
A change event for a notebook document.
NotebookDocumentClientCapabilities
Capabilities specific to the notebook document support.
NotebookDocumentFilterNotebookType
A notebook document filter where notebookType is required field.
NotebookDocumentFilterPattern
A notebook document filter where pattern is required field.
NotebookDocumentFilterScheme
A notebook document filter where scheme is required field.
NotebookDocumentFilterWithCells
@since 3.18.0
NotebookDocumentFilterWithNotebook
@since 3.18.0
NotebookDocumentIdentifier
A literal to identify a notebook document in the client.
NotebookDocumentSyncClientCapabilities
Notebook specific client capabilities.
NotebookDocumentSyncOptions
Options specific to a notebook plus its cells to be synced to the server.
NotebookDocumentSyncRegistrationOptions
Registration options specific to a notebook.
OptionalVersionedTextDocumentIdentifier
A text document identifier to optionally denote a specific version of a text document.
ParameterInformation
Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
Position
Position in a text document expressed as zero-based line and character offset. Prior to 3.17 the offsets were always based on a UTF-16 string representation. So a string of the form a𐐀b the character offset of the character a is 0, the character offset of 𐐀 is 1 and the character offset of b is 3 since 𐐀 is represented using two code units in UTF-16. Since 3.17 clients and servers can agree on a different string encoding representation (e.g. UTF-8). The client announces it’s supported encoding via the client capability general.positionEncodings. The value is an array of position encodings the client supports, with decreasing preference (e.g. the encoding at index 0 is the most preferred one). To stay backwards compatible the only mandatory encoding is UTF-16 represented via the string utf-16. The server can pick one of the encodings offered by the client and signals that encoding back to the client via the initialize result’s property capabilities.positionEncoding. If the string value utf-16 is missing from the client’s capability general.positionEncodings servers can safely assume that the client supports UTF-16. If the server omits the position encoding in its initialize result the encoding defaults to the string value utf-16. Implementation considerations: since the conversion from one encoding into another requires the content of the file / line the conversion is best done where the file is read which is usually on the server side.
PrepareRenameDefaultBehavior
@since 3.18.0
PrepareRenameParams
PrepareRenamePlaceholder
@since 3.18.0
PreviousResultId
A previous result id in a workspace pull request.
ProgressParams
PublishDiagnosticsClientCapabilities
The publish diagnostic client capabilities.
PublishDiagnosticsParams
The publish diagnostic notification’s parameters.
Range
A range in a text document expressed as (zero-based) start and end positions.
ReferenceClientCapabilities
Client Capabilities for a {@link ReferencesRequest}.
ReferenceContext
Value-object that contains additional information when requesting references.
ReferenceOptions
Reference options.
ReferenceParams
Parameters for a {@link ReferencesRequest}.
ReferenceRegistrationOptions
Registration options for a {@link ReferencesRequest}.
Registration
General parameters to register for a notification or to register a provider.
RegistrationParams
RegularExpressionsClientCapabilities
Client capabilities specific to regular expressions.
RelatedFullDocumentDiagnosticReport
A full diagnostic report with a set of related documents.
RelatedUnchangedDocumentDiagnosticReport
An unchanged diagnostic report with a set of related documents.
RelativePattern
A relative pattern is a helper to construct glob patterns that are matched relatively to a base URI. The common value for a baseUri is a workspace folder root, but it can be another absolute URI as well.
RenameClientCapabilities
RenameFile
Rename file operation
RenameFileOptions
Rename file options
RenameFilesParams
The parameters sent in notifications/requests for user-initiated renames of files.
RenameOptions
Provider options for a {@link RenameRequest}.
RenameParams
The parameters of a {@link RenameRequest}.
RenameRegistrationOptions
Registration options for a {@link RenameRequest}.
ResourceOperation
A generic resource operation.
SaveOptions
Save options.
SelectedCompletionInfo
Describes the currently selected completion item.
SelectionRange
A selection range represents a part of a selection hierarchy. A selection range may have a parent selection range that contains it.
SelectionRangeClientCapabilities
SelectionRangeOptions
SelectionRangeParams
A parameter literal used in selection range requests.
SelectionRangeRegistrationOptions
SemanticTokens
@since 3.16.0
SemanticTokensClientCapabilities
@since 3.16.0
SemanticTokensDelta
@since 3.16.0
SemanticTokensDeltaParams
@since 3.16.0
SemanticTokensDeltaPartialResult
@since 3.16.0
SemanticTokensEdit
@since 3.16.0
SemanticTokensFullDelta
Semantic tokens options to support deltas for full documents
SemanticTokensLegend
@since 3.16.0
SemanticTokensOptions
@since 3.16.0
SemanticTokensParams
@since 3.16.0
SemanticTokensPartialResult
@since 3.16.0
SemanticTokensRangeParams
@since 3.16.0
SemanticTokensRegistrationOptions
@since 3.16.0
SemanticTokensWorkspaceClientCapabilities
@since 3.16.0
ServerCapabilities
Defines the capabilities provided by a language server.
ServerCompletionItemOptions
@since 3.18.0
ServerInfo
Information about the server
SetTraceParams
ShowDocumentClientCapabilities
Client capabilities for the showDocument request.
ShowDocumentParams
Params to show a resource in the UI.
ShowDocumentResult
The result of a showDocument request.
ShowMessageParams
The parameters of a notification message.
ShowMessageRequestClientCapabilities
Show message request client capabilities
ShowMessageRequestParams
SignatureHelp
Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.
SignatureHelpClientCapabilities
Client Capabilities for a {@link SignatureHelpRequest}.
SignatureHelpContext
Additional information about the context in which a signature help request was triggered.
SignatureHelpOptions
Server Capabilities for a {@link SignatureHelpRequest}.
SignatureHelpParams
Parameters for a {@link SignatureHelpRequest}.
SignatureHelpRegistrationOptions
Registration options for a {@link SignatureHelpRequest}.
SignatureInformation
Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
SnippetTextEdit
An interactive text edit.
StaleRequestSupportOptions
@since 3.18.0
StringValue
A string value used as a snippet is a template which allows to insert text and to control the editor cursor when insertion happens.
SymbolInformation
Represents information about programming constructs like variables, classes, interfaces etc.
TextDocumentChangeRegistrationOptions
Describe options to be used when registered for text document change events.
TextDocumentClientCapabilities
Text document specific client capabilities.
TextDocumentContentChangePartial
@since 3.18.0
TextDocumentContentChangeWholeDocument
@since 3.18.0
TextDocumentContentClientCapabilities
Client capabilities for a text document content provider.
TextDocumentContentOptions
Text document content provider options.
TextDocumentContentParams
Parameters for the workspace/textDocumentContent request.
TextDocumentContentRefreshParams
Parameters for the workspace/textDocumentContent/refresh request.
TextDocumentContentRegistrationOptions
Text document content provider registration options.
TextDocumentContentResult
Result of the workspace/textDocumentContent request.
TextDocumentEdit
Describes textual changes on a text document. A TextDocumentEdit describes all changes on a document version Si and after they are applied move the document to version Si+1. So the creator of a TextDocumentEdit doesn’t need to sort the array of edits or do any kind of ordering. However the edits must be non overlapping.
TextDocumentFilterClientCapabilities
TextDocumentFilterLanguage
A document filter where language is required field.
TextDocumentFilterPattern
A document filter where pattern is required field.
TextDocumentFilterScheme
A document filter where scheme is required field.
TextDocumentIdentifier
A literal to identify a text document in the client.
TextDocumentItem
An item to transfer a text document from the client to the server.
TextDocumentSaveRegistrationOptions
Save registration options.
TextDocumentSyncClientCapabilities
TextDocumentSyncOptions
TextEdit
A text edit applicable to a text document.
TypeDefinitionClientCapabilities
Since 3.6.0
TypeDefinitionOptions
TypeDefinitionParams
TypeDefinitionRegistrationOptions
TypeHierarchyClientCapabilities
@since 3.17.0
TypeHierarchyItem
@since 3.17.0
TypeHierarchyOptions
Type hierarchy options used during static registration.
TypeHierarchyPrepareParams
The parameter of a textDocument/prepareTypeHierarchy request.
TypeHierarchyRegistrationOptions
Type hierarchy options used during static or dynamic registration.
TypeHierarchySubtypesParams
The parameter of a typeHierarchy/subtypes request.
TypeHierarchySupertypesParams
The parameter of a typeHierarchy/supertypes request.
UnchangedDocumentDiagnosticReport
A diagnostic report indicating that the last returned report is still accurate.
Unregistration
General parameters to unregister a request or notification.
UnregistrationParams
VersionedNotebookDocumentIdentifier
A versioned notebook document identifier.
VersionedTextDocumentIdentifier
A text document identifier to denote a specific version of a text document.
WillSaveTextDocumentParams
The parameters sent in a will save text document notification.
WindowClientCapabilities
WorkDoneProgressBegin
WorkDoneProgressCancelParams
WorkDoneProgressCreateParams
WorkDoneProgressEnd
WorkDoneProgressParams
WorkDoneProgressReport
WorkspaceClientCapabilities
Workspace specific client capabilities.
WorkspaceDiagnosticParams
Parameters of the workspace diagnostic request.
WorkspaceDiagnosticReport
A workspace diagnostic report.
WorkspaceDiagnosticReportPartialResult
A partial result for a workspace diagnostic report.
WorkspaceEdit
A workspace edit represents changes to many resources managed in the workspace. The edit should either provide changes or documentChanges. If documentChanges are present they are preferred over changes if the client can handle versioned document edits.
WorkspaceEditClientCapabilities
WorkspaceEditMetadata
Additional data about a workspace edit.
WorkspaceFolder
A workspace folder inside a client.
WorkspaceFoldersChangeEvent
The workspace folder change event.
WorkspaceFoldersInitializeParams
WorkspaceFoldersServerCapabilities
WorkspaceFullDocumentDiagnosticReport
A full document diagnostic report for a workspace diagnostic result.
WorkspaceOptions
Defines workspace specific capabilities of the server.
WorkspaceSymbol
A special workspace symbol that supports locations without a range.
WorkspaceSymbolClientCapabilities
Client capabilities for a {@link WorkspaceSymbolRequest}.
WorkspaceSymbolOptions
Server capabilities for a {@link WorkspaceSymbolRequest}.
WorkspaceSymbolParams
The parameters of a {@link WorkspaceSymbolRequest}.
WorkspaceSymbolRegistrationOptions
Registration options for a {@link WorkspaceSymbolRequest}.
WorkspaceUnchangedDocumentDiagnosticReport
An unchanged document diagnostic report for a workspace diagnostic result.

Enums§

ApplyKind
Defines how values from a set of defaults and an individual item will be merged.
CodeActionKind
A set of predefined code action kinds
CodeActionTag
Code action tags are extra annotations that tweak the behavior of a code action.
CodeActionTriggerKind
The reason why code actions were requested.
CompletionItemKind
The kind of a completion entry.
CompletionItemTag
Completion item tags are extra annotations that tweak the rendering of a completion item.
CompletionTriggerKind
How a completion was triggered
DiagnosticSeverity
The diagnostic’s severity.
DiagnosticTag
The diagnostic tags.
DocumentDiagnosticReportKind
The document diagnostic report kinds.
DocumentHighlightKind
A document highlight kind.
ErrorCodes
Predefined error codes.
FailureHandlingKind
FileChangeType
The file event type
FileOperationPatternKind
A pattern kind describing if a glob pattern matches a file a folder or both.
FoldingRangeKind
A set of predefined range kinds.
InlayHintKind
Inlay hint kinds.
InlineCompletionTriggerKind
Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
InsertTextFormat
Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.
InsertTextMode
How whitespace and indentation is handled during completion item insertion.
LSPErrorCodes
LanguageKind
Predefined Language kinds @since 3.18.0 @proposed
MarkupKind
Describes the content type that a client supports in various result literals like Hover, ParameterInfo or CompletionItem.
MessageType
The message type
MonikerKind
The moniker kind.
NotebookCellKind
A notebook cell kind.
PositionEncodingKind
A set of predefined position encoding kinds.
PrepareSupportDefaultBehavior
ResourceOperationKind
SemanticTokenModifiers
A set of predefined token modifiers. This set is not fixed an clients can specify additional token types via the corresponding client capabilities.
SemanticTokenTypes
A set of predefined token types. This set is not fixed an clients can specify additional token types via the corresponding client capabilities.
SignatureHelpTriggerKind
How a signature help was triggered.
SymbolKind
A symbol kind.
SymbolTag
Symbol tags are extra annotations that tweak the rendering of a symbol.
TextDocumentSaveReason
Represents reasons why a text document is saved.
TextDocumentSyncKind
Defines how the host (editor) should sync document changes to the language server.
TokenFormat
TraceValue
Union2
Union3
Union4
UniquenessLevel
Moniker uniqueness level to define scope of the moniker.
WatchKind

Type Aliases§

ChangeAnnotationIdentifier
An identifier to refer to a change annotation stored with a workspace edit.
Declaration
The declaration of a symbol representation as one or many {@link Location locations}.
DeclarationLink
Information about where a symbol is declared.
Definition
The definition of a symbol represented as one or many {@link Location locations}. For most programming languages there is only one location at which a symbol is defined.
DefinitionLink
Information about where a symbol is defined.
DocumentDiagnosticReport
The result of a document diagnostic pull request. A report can either be a full report containing all diagnostics for the requested document or an unchanged report indicating that nothing has changed in terms of diagnostics in comparison to the last pull request.
DocumentFilter
A document filter describes a top level text document or a notebook cell document.
DocumentSelector
A document selector is the combination of one or many document filters.
GlobPattern
The glob pattern. Either a string pattern or a relative pattern.
HashMap
InlineValue
Inline value information can be provided by different means:
MarkedString
MarkedString can be used to render human readable text. It is either a markdown string or a code-block that provides a language and a code snippet. The language identifier is semantically equal to the optional language identifier in fenced code blocks in GitHub issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
NotebookDocumentFilter
A notebook document filter denotes a notebook document by different properties. The properties will be match against the notebook’s URI (same as with documents)
Pattern
The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
PrepareRenameResult
ProgressToken
RegularExpressionEngineKind
TextDocumentContentChangeEvent
An event describing a change to a text document. If only a text is provided it is considered to be the full content of the document.
TextDocumentFilter
A document filter denotes a document by different properties like the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
Uri
WorkspaceDocumentDiagnosticReport
A workspace diagnostic document report.