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§
Structs§
- Annotated
Text Edit - A special text edit with an additional change annotation.
- Apply
Workspace Edit Params - The parameters passed via an apply workspace edit request.
- Apply
Workspace Edit Result - The result returned from the apply workspace edit request.
- Base
Symbol Information - A base for all symbol information.
- Call
Hierarchy Client Capabilities - @since 3.16.0
- Call
Hierarchy Incoming Call - Represents an incoming call, e.g. a caller of a method or constructor.
- Call
Hierarchy Incoming Calls Params - The parameter of a
callHierarchy/incomingCalls
request. - Call
Hierarchy Item - Represents programming constructs like functions or constructors in the context of call hierarchy.
- Call
Hierarchy Options - Call hierarchy options used during static registration.
- Call
Hierarchy Outgoing Call - Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
- Call
Hierarchy Outgoing Calls Params - The parameter of a
callHierarchy/outgoingCalls
request. - Call
Hierarchy Prepare Params - The parameter of a
textDocument/prepareCallHierarchy
request. - Call
Hierarchy Registration Options - Call hierarchy options used during static or dynamic registration.
- Cancel
Params - Change
Annotation - Additional information that describes document changes.
- Change
Annotations Support Options - @since 3.18.0
- Client
Capabilities - Defines the capabilities provided by the client.
- Client
Code Action Kind Options - @since 3.18.0
- Client
Code Action Literal Options - @since 3.18.0
- Client
Code Action Resolve Options - @since 3.18.0
- Client
Code Lens Resolve Options - @since 3.18.0
- Client
Completion Item Insert Text Mode Options - @since 3.18.0
- Client
Completion Item Options - @since 3.18.0
- Client
Completion Item Options Kind - @since 3.18.0
- Client
Completion Item Resolve Options - @since 3.18.0
- Client
Diagnostics TagOptions - @since 3.18.0
- Client
Folding Range Kind Options - @since 3.18.0
- Client
Folding Range Options - @since 3.18.0
- Client
Info - Information about the client
- Client
Inlay Hint Resolve Options - @since 3.18.0
- Client
Semantic Tokens Request Full Delta - @since 3.18.0
- Client
Semantic Tokens Request Options - @since 3.18.0
- Client
Show Message Action Item Options - @since 3.18.0
- Client
Signature Information Options - @since 3.18.0
- Client
Signature Parameter Information Options - @since 3.18.0
- Client
Symbol Kind Options - @since 3.18.0
- Client
Symbol Resolve Options - @since 3.18.0
- Client
Symbol TagOptions - @since 3.18.0
- Code
Action - A code action represents a change that can be performed in code, e.g. to fix a problem or to refactor code.
- Code
Action Client Capabilities - The Client Capabilities of a {@link CodeActionRequest}.
- Code
Action Context - Contains additional diagnostic information about the context in which a {@link CodeActionProvider.provideCodeActions code action} is run.
- Code
Action Disabled - Captures why the code action is currently disabled.
- Code
Action Kind Documentation - Documentation for a class of code actions.
- Code
Action Options - Provider options for a {@link CodeActionRequest}.
- Code
Action Params - The parameters of a {@link CodeActionRequest}.
- Code
Action Registration Options - Registration options for a {@link CodeActionRequest}.
- Code
Action TagOptions - @since 3.18.0 - proposed
- Code
Description - Structure to capture a description for an error code.
- Code
Lens - 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.
- Code
Lens Client Capabilities - The client capabilities of a {@link CodeLensRequest}.
- Code
Lens Options - Code Lens provider options of a {@link CodeLensRequest}.
- Code
Lens Params - The parameters of a {@link CodeLensRequest}.
- Code
Lens Registration Options - Registration options for a {@link CodeLensRequest}.
- Code
Lens Workspace Client Capabilities - @since 3.16.0
- Color
- Represents a color in RGBA space.
- Color
Information - Represents a color range from a document.
- Color
Presentation - Color
Presentation Params - 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.
- Completion
Client Capabilities - Completion client capabilities
- Completion
Context - Contains additional information about the context in which a completion request is triggered.
- Completion
Item - A completion item represents a text snippet that is proposed to complete text that is being typed.
- Completion
Item Apply Kinds - Specifies how fields from a completion item should be combined with those
from
completionList.itemDefaults
. - Completion
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. - Completion
Item Label Details - Additional details for a completion item label.
- Completion
Item TagOptions - @since 3.18.0
- Completion
List - Represents a collection of {@link CompletionItem completion items} to be presented in the editor.
- Completion
List Capabilities - The client supports the following
CompletionList
specific capabilities. - Completion
Options - Completion options.
- Completion
Params - Completion parameters
- Completion
Registration Options - Registration options for a {@link CompletionRequest}.
- Configuration
Item - Configuration
Params - The parameters of a configuration request.
- Create
File - Create file operation.
- Create
File Options - Options to create a file.
- Create
Files Params - The parameters sent in notifications/requests for user-initiated creation of files.
- Declaration
Client Capabilities - @since 3.14.0
- Declaration
Options - Declaration
Params - Declaration
Registration Options - Definition
Client Capabilities - Client Capabilities for a {@link DefinitionRequest}.
- Definition
Options - Server Capabilities for a {@link DefinitionRequest}.
- Definition
Params - Parameters for a {@link DefinitionRequest}.
- Definition
Registration Options - Registration options for a {@link DefinitionRequest}.
- Delete
File - Delete file operation
- Delete
File Options - Delete file options
- Delete
Files Params - 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.
- Diagnostic
Client Capabilities - Client capabilities specific to diagnostic pull requests.
- Diagnostic
Options - Diagnostic options.
- Diagnostic
Registration Options - Diagnostic registration options.
- Diagnostic
Related Information - 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.
- Diagnostic
Server Cancellation Data - Cancellation data returned from a diagnostic request.
- Diagnostic
Workspace Client Capabilities - Workspace client capabilities specific to diagnostic pull requests.
- Diagnostics
Capabilities - General diagnostics capabilities for pull and push model.
- DidChange
Configuration Client Capabilities - DidChange
Configuration Params - The parameters of a change configuration notification.
- DidChange
Configuration Registration Options - DidChange
Notebook Document Params - The params sent in a change notebook document notification.
- DidChange
Text Document Params - The change text document notification’s parameters.
- DidChange
Watched Files Client Capabilities - DidChange
Watched Files Params - The watched files change notification’s parameters.
- DidChange
Watched Files Registration Options - Describe options to be used when registered for text document change events.
- DidChange
Workspace Folders Params - The parameters of a
workspace/didChangeWorkspaceFolders
notification. - DidClose
Notebook Document Params - The params sent in a close notebook document notification.
- DidClose
Text Document Params - The parameters sent in a close text document notification
- DidOpen
Notebook Document Params - The params sent in an open notebook document notification.
- DidOpen
Text Document Params - The parameters sent in an open text document notification
- DidSave
Notebook Document Params - The params sent in a save notebook document notification.
- DidSave
Text Document Params - The parameters sent in a save text document notification
- Document
Color Client Capabilities - Document
Color Options - Document
Color Params - Parameters for a {@link DocumentColorRequest}.
- Document
Color Registration Options - Document
Diagnostic Params - Parameters of the document diagnostic request.
- Document
Diagnostic Report Partial Result - A partial result for a document diagnostic report.
- Document
Formatting Client Capabilities - Client capabilities of a {@link DocumentFormattingRequest}.
- Document
Formatting Options - Provider options for a {@link DocumentFormattingRequest}.
- Document
Formatting Params - The parameters of a {@link DocumentFormattingRequest}.
- Document
Formatting Registration Options - Registration options for a {@link DocumentFormattingRequest}.
- Document
Highlight - 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.
- Document
Highlight Client Capabilities - Client Capabilities for a {@link DocumentHighlightRequest}.
- Document
Highlight Options - Provider options for a {@link DocumentHighlightRequest}.
- Document
Highlight Params - Parameters for a {@link DocumentHighlightRequest}.
- Document
Highlight Registration Options - Registration options for a {@link DocumentHighlightRequest}.
- Document
Link - 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.
- Document
Link Client Capabilities - The client capabilities of a {@link DocumentLinkRequest}.
- Document
Link Options - Provider options for a {@link DocumentLinkRequest}.
- Document
Link Params - The parameters of a {@link DocumentLinkRequest}.
- Document
Link Registration Options - Registration options for a {@link DocumentLinkRequest}.
- Document
OnType Formatting Client Capabilities - Client capabilities of a {@link DocumentOnTypeFormattingRequest}.
- Document
OnType Formatting Options - Provider options for a {@link DocumentOnTypeFormattingRequest}.
- Document
OnType Formatting Params - The parameters of a {@link DocumentOnTypeFormattingRequest}.
- Document
OnType Formatting Registration Options - Registration options for a {@link DocumentOnTypeFormattingRequest}.
- Document
Range Formatting Client Capabilities - Client capabilities of a {@link DocumentRangeFormattingRequest}.
- Document
Range Formatting Options - Provider options for a {@link DocumentRangeFormattingRequest}.
- Document
Range Formatting Params - The parameters of a {@link DocumentRangeFormattingRequest}.
- Document
Range Formatting Registration Options - Registration options for a {@link DocumentRangeFormattingRequest}.
- Document
Ranges Formatting Params - The parameters of a {@link DocumentRangesFormattingRequest}.
- Document
Symbol - 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.
- Document
Symbol Client Capabilities - Client Capabilities for a {@link DocumentSymbolRequest}.
- Document
Symbol Options - Provider options for a {@link DocumentSymbolRequest}.
- Document
Symbol Params - Parameters for a {@link DocumentSymbolRequest}.
- Document
Symbol Registration Options - Registration options for a {@link DocumentSymbolRequest}.
- Edit
Range With Insert Replace - Edit range variant that includes ranges for insert and replace operations.
- Execute
Command Client Capabilities - The client capabilities of a {@link ExecuteCommandRequest}.
- Execute
Command Options - The server capabilities of a {@link ExecuteCommandRequest}.
- Execute
Command Params - The parameters of a {@link ExecuteCommandRequest}.
- Execute
Command Registration Options - Registration options for a {@link ExecuteCommandRequest}.
- Execution
Summary - File
Create - Represents information on a file/folder create.
- File
Delete - Represents information on a file/folder delete.
- File
Event - An event describing a file change.
- File
Operation Client Capabilities - Capabilities relating to events from file operations by the user in the client.
- File
Operation Filter - A filter to describe in which file operation requests or notifications the server is interested in receiving.
- File
Operation Options - Options for notifications/requests for user operations on files.
- File
Operation Pattern - A pattern to describe in which file operation requests or notifications the server is interested in receiving.
- File
Operation Pattern Options - Matching options for the file operation pattern.
- File
Operation Registration Options - The options to register for file operations.
- File
Rename - Represents information on a file/folder rename.
- File
System Watcher - Folding
Range - 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.
- Folding
Range Client Capabilities - Folding
Range Options - Folding
Range Params - Parameters for a {@link FoldingRangeRequest}.
- Folding
Range Registration Options - Folding
Range Workspace Client Capabilities - Client workspace capabilities specific to folding ranges
- Formatting
Options - Value-object describing what options formatting should use.
- Full
Document Diagnostic Report - A diagnostic report with a full set of problems.
- General
Client Capabilities - General client capabilities.
- Hover
- The result of a hover request.
- Hover
Client Capabilities - Hover
Options - Hover options.
- Hover
Params - Parameters for a {@link HoverRequest}.
- Hover
Registration Options - Registration options for a {@link HoverRequest}.
- Implementation
Client Capabilities - @since 3.6.0
- Implementation
Options - Implementation
Params - Implementation
Registration Options - Initialize
Error - The data type of the ResponseError if the initialize request fails.
- Initialize
Params - Initialize
Result - The result returned from an initialize request.
- Initialized
Params - Inlay
Hint - Inlay hint information.
- Inlay
Hint Client Capabilities - Inlay hint client capabilities.
- Inlay
Hint Label Part - An inlay hint label part allows for interactive and composite labels of inlay hints.
- Inlay
Hint Options - Inlay hint options used during static registration.
- Inlay
Hint Params - A parameter literal used in inlay hint requests.
- Inlay
Hint Registration Options - Inlay hint options used during static or dynamic registration.
- Inlay
Hint Workspace Client Capabilities - Client workspace capabilities specific to inlay hints.
- Inline
Completion Client Capabilities - Client capabilities specific to inline completions.
- Inline
Completion Context - Provides information about the context in which an inline completion was requested.
- Inline
Completion Item - An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
- Inline
Completion List - Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.
- Inline
Completion Options - Inline completion options used during static registration.
- Inline
Completion Params - A parameter literal used in inline completion requests.
- Inline
Completion Registration Options - Inline completion options used during static or dynamic registration.
- Inline
Value Client Capabilities - Client capabilities specific to inline values.
- Inline
Value Context - @since 3.17.0
- Inline
Value Evaluatable Expression - 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.
- Inline
Value Options - Inline value options used during static registration.
- Inline
Value Params - A parameter literal used in inline value requests.
- Inline
Value Registration Options - Inline value options used during static or dynamic registration.
- Inline
Value Text - Provide inline value as text.
- Inline
Value Variable Lookup - 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.
- Inline
Value Workspace Client Capabilities - Client workspace capabilities specific to inline values.
- Insert
Replace Edit - A special text edit to provide an insert and a replace operation.
- Linked
Editing Range Client Capabilities - Client capabilities for the linked editing range request.
- Linked
Editing Range Options - Linked
Editing Range Params - Linked
Editing Range Registration Options - Linked
Editing Ranges - The result of a linked editing range request.
- Location
- Represents a location inside a resource, such as a line inside a text file.
- Location
Link - Represents the connection of two locations. Provides additional metadata over normal {@link Location locations}, including an origin range.
- Location
UriOnly - Location with only uri and does not include range.
- LogMessage
Params - The log message parameters.
- LogTrace
Params - Markdown
Client Capabilities - Client capabilities specific to the used markdown parser.
- Marked
String With Language Deprecated - @since 3.18.0 @deprecated use MarkupContent instead.
- Markup
Content - A
MarkupContent
literal represents a string value which content is interpreted base on its kind flag. Currently the protocol supportsplaintext
andmarkdown
as markup kinds. - Message
Action Item - Moniker
- Moniker definition to match LSIF 0.5 moniker definition.
- Moniker
Client Capabilities - Client capabilities specific to the moniker request.
- Moniker
Options - Moniker
Params - Moniker
Registration Options - Notebook
Cell - A notebook cell.
- Notebook
Cell Array Change - A change describing how to move a
NotebookCell
array from state S to S’. - Notebook
Cell Language - @since 3.18.0
- Notebook
Cell Text Document Filter - A notebook cell text document filter denotes a cell text document by different properties.
- Notebook
Document - A notebook document.
- Notebook
Document Cell Change Structure - Structural changes to cells in a notebook document.
- Notebook
Document Cell Changes - Cell changes to a notebook document.
- Notebook
Document Cell Content Changes - Content changes to a cell in a notebook document.
- Notebook
Document Change Event - A change event for a notebook document.
- Notebook
Document Client Capabilities - Capabilities specific to the notebook document support.
- Notebook
Document Filter Notebook Type - A notebook document filter where
notebookType
is required field. - Notebook
Document Filter Pattern - A notebook document filter where
pattern
is required field. - Notebook
Document Filter Scheme - A notebook document filter where
scheme
is required field. - Notebook
Document Filter With Cells - @since 3.18.0
- Notebook
Document Filter With Notebook - @since 3.18.0
- Notebook
Document Identifier - A literal to identify a notebook document in the client.
- Notebook
Document Sync Client Capabilities - Notebook specific client capabilities.
- Notebook
Document Sync Options - Options specific to a notebook plus its cells to be synced to the server.
- Notebook
Document Sync Registration Options - Registration options specific to a notebook.
- Optional
Versioned Text Document Identifier - A text document identifier to optionally denote a specific version of a text document.
- Parameter
Information - 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 charactera
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 capabilitygeneral.positionEncodings
. The value is an array of position encodings the client supports, with decreasing preference (e.g. the encoding at index0
is the most preferred one). To stay backwards compatible the only mandatory encoding is UTF-16 represented via the stringutf-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 propertycapabilities.positionEncoding
. If the string valueutf-16
is missing from the client’s capabilitygeneral.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 valueutf-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. - Prepare
Rename Default Behavior - @since 3.18.0
- Prepare
Rename Params - Prepare
Rename Placeholder - @since 3.18.0
- Previous
Result Id - A previous result id in a workspace pull request.
- Progress
Params - Publish
Diagnostics Client Capabilities - The publish diagnostic client capabilities.
- Publish
Diagnostics Params - The publish diagnostic notification’s parameters.
- Range
- A range in a text document expressed as (zero-based) start and end positions.
- Reference
Client Capabilities - Client Capabilities for a {@link ReferencesRequest}.
- Reference
Context - Value-object that contains additional information when requesting references.
- Reference
Options - Reference options.
- Reference
Params - Parameters for a {@link ReferencesRequest}.
- Reference
Registration Options - Registration options for a {@link ReferencesRequest}.
- Registration
- General parameters to register for a notification or to register a provider.
- Registration
Params - Regular
Expressions Client Capabilities - Client capabilities specific to regular expressions.
- Related
Full Document Diagnostic Report - A full diagnostic report with a set of related documents.
- Related
Unchanged Document Diagnostic Report - An unchanged diagnostic report with a set of related documents.
- Relative
Pattern - 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. - Rename
Client Capabilities - Rename
File - Rename file operation
- Rename
File Options - Rename file options
- Rename
Files Params - The parameters sent in notifications/requests for user-initiated renames of files.
- Rename
Options - Provider options for a {@link RenameRequest}.
- Rename
Params - The parameters of a {@link RenameRequest}.
- Rename
Registration Options - Registration options for a {@link RenameRequest}.
- Resource
Operation - A generic resource operation.
- Save
Options - Save options.
- Selected
Completion Info - Describes the currently selected completion item.
- Selection
Range - A selection range represents a part of a selection hierarchy. A selection range may have a parent selection range that contains it.
- Selection
Range Client Capabilities - Selection
Range Options - Selection
Range Params - A parameter literal used in selection range requests.
- Selection
Range Registration Options - Semantic
Tokens - @since 3.16.0
- Semantic
Tokens Client Capabilities - @since 3.16.0
- Semantic
Tokens Delta - @since 3.16.0
- Semantic
Tokens Delta Params - @since 3.16.0
- Semantic
Tokens Delta Partial Result - @since 3.16.0
- Semantic
Tokens Edit - @since 3.16.0
- Semantic
Tokens Full Delta - Semantic tokens options to support deltas for full documents
- Semantic
Tokens Legend - @since 3.16.0
- Semantic
Tokens Options - @since 3.16.0
- Semantic
Tokens Params - @since 3.16.0
- Semantic
Tokens Partial Result - @since 3.16.0
- Semantic
Tokens Range Params - @since 3.16.0
- Semantic
Tokens Registration Options - @since 3.16.0
- Semantic
Tokens Workspace Client Capabilities - @since 3.16.0
- Server
Capabilities - Defines the capabilities provided by a language server.
- Server
Completion Item Options - @since 3.18.0
- Server
Info - Information about the server
- SetTrace
Params - Show
Document Client Capabilities - Client capabilities for the showDocument request.
- Show
Document Params - Params to show a resource in the UI.
- Show
Document Result - The result of a showDocument request.
- Show
Message Params - The parameters of a notification message.
- Show
Message Request Client Capabilities - Show message request client capabilities
- Show
Message Request Params - Signature
Help - Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.
- Signature
Help Client Capabilities - Client Capabilities for a {@link SignatureHelpRequest}.
- Signature
Help Context - Additional information about the context in which a signature help request was triggered.
- Signature
Help Options - Server Capabilities for a {@link SignatureHelpRequest}.
- Signature
Help Params - Parameters for a {@link SignatureHelpRequest}.
- Signature
Help Registration Options - Registration options for a {@link SignatureHelpRequest}.
- Signature
Information - Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
- Snippet
Text Edit - An interactive text edit.
- Stale
Request Support Options - @since 3.18.0
- String
Value - A string value used as a snippet is a template which allows to insert text and to control the editor cursor when insertion happens.
- Symbol
Information - Represents information about programming constructs like variables, classes, interfaces etc.
- Text
Document Change Registration Options - Describe options to be used when registered for text document change events.
- Text
Document Client Capabilities - Text document specific client capabilities.
- Text
Document Content Change Partial - @since 3.18.0
- Text
Document Content Change Whole Document - @since 3.18.0
- Text
Document Content Client Capabilities - Client capabilities for a text document content provider.
- Text
Document Content Options - Text document content provider options.
- Text
Document Content Params - Parameters for the
workspace/textDocumentContent
request. - Text
Document Content Refresh Params - Parameters for the
workspace/textDocumentContent/refresh
request. - Text
Document Content Registration Options - Text document content provider registration options.
- Text
Document Content Result - Result of the
workspace/textDocumentContent
request. - Text
Document Edit - 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.
- Text
Document Filter Client Capabilities - Text
Document Filter Language - A document filter where
language
is required field. - Text
Document Filter Pattern - A document filter where
pattern
is required field. - Text
Document Filter Scheme - A document filter where
scheme
is required field. - Text
Document Identifier - A literal to identify a text document in the client.
- Text
Document Item - An item to transfer a text document from the client to the server.
- Text
Document Save Registration Options - Save registration options.
- Text
Document Sync Client Capabilities - Text
Document Sync Options - Text
Edit - A text edit applicable to a text document.
- Type
Definition Client Capabilities - Since 3.6.0
- Type
Definition Options - Type
Definition Params - Type
Definition Registration Options - Type
Hierarchy Client Capabilities - @since 3.17.0
- Type
Hierarchy Item - @since 3.17.0
- Type
Hierarchy Options - Type hierarchy options used during static registration.
- Type
Hierarchy Prepare Params - The parameter of a
textDocument/prepareTypeHierarchy
request. - Type
Hierarchy Registration Options - Type hierarchy options used during static or dynamic registration.
- Type
Hierarchy Subtypes Params - The parameter of a
typeHierarchy/subtypes
request. - Type
Hierarchy Supertypes Params - The parameter of a
typeHierarchy/supertypes
request. - Unchanged
Document Diagnostic Report - A diagnostic report indicating that the last returned report is still accurate.
- Unregistration
- General parameters to unregister a request or notification.
- Unregistration
Params - Versioned
Notebook Document Identifier - A versioned notebook document identifier.
- Versioned
Text Document Identifier - A text document identifier to denote a specific version of a text document.
- Will
Save Text Document Params - The parameters sent in a will save text document notification.
- Window
Client Capabilities - Work
Done Progress Begin - Work
Done Progress Cancel Params - Work
Done Progress Create Params - Work
Done Progress End - Work
Done Progress Params - Work
Done Progress Report - Workspace
Client Capabilities - Workspace specific client capabilities.
- Workspace
Diagnostic Params - Parameters of the workspace diagnostic request.
- Workspace
Diagnostic Report - A workspace diagnostic report.
- Workspace
Diagnostic Report Partial Result - A partial result for a workspace diagnostic report.
- Workspace
Edit - A workspace edit represents changes to many resources managed in the workspace. The edit
should either provide
changes
ordocumentChanges
. If documentChanges are present they are preferred overchanges
if the client can handle versioned document edits. - Workspace
Edit Client Capabilities - Workspace
Edit Metadata - Additional data about a workspace edit.
- Workspace
Folder - A workspace folder inside a client.
- Workspace
Folders Change Event - The workspace folder change event.
- Workspace
Folders Initialize Params - Workspace
Folders Server Capabilities - Workspace
Full Document Diagnostic Report - A full document diagnostic report for a workspace diagnostic result.
- Workspace
Options - Defines workspace specific capabilities of the server.
- Workspace
Symbol - A special workspace symbol that supports locations without a range.
- Workspace
Symbol Client Capabilities - Client capabilities for a {@link WorkspaceSymbolRequest}.
- Workspace
Symbol Options - Server capabilities for a {@link WorkspaceSymbolRequest}.
- Workspace
Symbol Params - The parameters of a {@link WorkspaceSymbolRequest}.
- Workspace
Symbol Registration Options - Registration options for a {@link WorkspaceSymbolRequest}.
- Workspace
Unchanged Document Diagnostic Report - An unchanged document diagnostic report for a workspace diagnostic result.
Enums§
- Apply
Kind - Defines how values from a set of defaults and an individual item will be merged.
- Code
Action Kind - A set of predefined code action kinds
- Code
Action Tag - Code action tags are extra annotations that tweak the behavior of a code action.
- Code
Action Trigger Kind - The reason why code actions were requested.
- Completion
Item Kind - The kind of a completion entry.
- Completion
Item Tag - Completion item tags are extra annotations that tweak the rendering of a completion item.
- Completion
Trigger Kind - How a completion was triggered
- Diagnostic
Severity - The diagnostic’s severity.
- Diagnostic
Tag - The diagnostic tags.
- Document
Diagnostic Report Kind - The document diagnostic report kinds.
- Document
Highlight Kind - A document highlight kind.
- Error
Codes - Predefined error codes.
- Failure
Handling Kind - File
Change Type - The file event type
- File
Operation Pattern Kind - A pattern kind describing if a glob pattern matches a file a folder or both.
- Folding
Range Kind - A set of predefined range kinds.
- Inlay
Hint Kind - Inlay hint kinds.
- Inline
Completion Trigger Kind - Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
- Insert
Text Format - Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.
- Insert
Text Mode - How whitespace and indentation is handled during completion item insertion.
- LSPError
Codes - Language
Kind - Predefined Language kinds @since 3.18.0 @proposed
- Markup
Kind - Describes the content type that a client supports in various
result literals like
Hover
,ParameterInfo
orCompletionItem
. - Message
Type - The message type
- Moniker
Kind - The moniker kind.
- Notebook
Cell Kind - A notebook cell kind.
- Position
Encoding Kind - A set of predefined position encoding kinds.
- Prepare
Support Default Behavior - Resource
Operation Kind - Semantic
Token Modifiers - A set of predefined token modifiers. This set is not fixed an clients can specify additional token types via the corresponding client capabilities.
- Semantic
Token Types - A set of predefined token types. This set is not fixed an clients can specify additional token types via the corresponding client capabilities.
- Signature
Help Trigger Kind - How a signature help was triggered.
- Symbol
Kind - A symbol kind.
- Symbol
Tag - Symbol tags are extra annotations that tweak the rendering of a symbol.
- Text
Document Save Reason - Represents reasons why a text document is saved.
- Text
Document Sync Kind - Defines how the host (editor) should sync document changes to the language server.
- Token
Format - Trace
Value - Union2
- Union3
- Union4
- Uniqueness
Level - Moniker uniqueness level to define scope of the moniker.
- Watch
Kind
Type Aliases§
- Change
Annotation Identifier - 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}.
- Declaration
Link - 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.
- Definition
Link - Information about where a symbol is defined.
- Document
Diagnostic Report - 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.
- Document
Filter - A document filter describes a top level text document or a notebook cell document.
- Document
Selector - A document selector is the combination of one or many document filters.
- Glob
Pattern - The glob pattern. Either a string pattern or a relative pattern.
- HashMap
- Inline
Value - Inline value information can be provided by different means:
- Marked
String - 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
- Notebook
Document Filter - 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:
- Prepare
Rename Result - Progress
Token - Regular
Expression Engine Kind - Text
Document Content Change Event - 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.
- Text
Document Filter - 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
- Workspace
Document Diagnostic Report - A workspace diagnostic document report.