lsp_server library

Classes

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.
ClientCapabilities
Defines the capabilities provided by the client.
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 CodeActionRequest.
CodeActionClientCapabilitiesCodeActionLiteralSupport
CodeActionClientCapabilitiesResolveSupport
CodeActionContext
Contains additional diagnostic information about the context in which a CodeActionProvider.provideCodeActions is run.
CodeActionDisabled
CodeActionKind
A set of predefined code action kinds
CodeActionLiteralSupportCodeActionKind
CodeActionOptions
Provider options for a CodeActionRequest.
CodeActionParams
The parameters of a CodeActionRequest.
CodeActionRegistrationOptions
Registration options for a CodeActionRequest.
CodeActionTriggerKind
The reason why code actions were requested.
CodeDescription
Structure to capture a description for an error code.
CodeLens
A code lens represents a 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 CodeLensRequest.
CodeLensOptions
Code Lens provider options of a CodeLensRequest.
CodeLensParams
The parameters of a CodeLensRequest.
CodeLensRegistrationOptions
Registration options for a 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 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
CompletionClientCapabilitiesCompletionItem
CompletionClientCapabilitiesCompletionItemKind
CompletionClientCapabilitiesCompletionList
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.
CompletionItemEditRange
CompletionItemInsertTextModeSupport
CompletionItemKind
The kind of a completion entry.
CompletionItemLabelDetails
Additional details for a completion item label.
CompletionItemResolveSupport
CompletionItemTag
Completion item tags are extra annotations that tweak the rendering of a completion item.
CompletionItemTagSupport
CompletionList
Represents a collection of CompletionItem to be presented in the editor.
CompletionListItemDefaults
CompletionOptions
Completion options.
CompletionOptionsCompletionItem
CompletionParams
Completion parameters
CompletionRegistrationOptions
Registration options for a CompletionRequest.
CompletionTriggerKind
How a completion was triggered
ConfigurationItem
ConfigurationParams
The parameters of a configuration request.
Connection
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 DefinitionRequest.
DefinitionOptions
Server Capabilities for a DefinitionRequest.
DefinitionParams
Parameters for a DefinitionRequest.
DefinitionRegistrationOptions
Registration options for a 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.
DiagnosticSeverity
The diagnostic's severity.
DiagnosticTag
The diagnostic tags.
DiagnosticWorkspaceClientCapabilities
Workspace client capabilities specific to diagnostic pull requests.
DidChangeConfigurationClientCapabilities
DidChangeConfigurationParams
The parameters of a change configuration notification.
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 DocumentColorRequest.
DocumentColorRegistrationOptions
DocumentDiagnosticParams
Parameters of the document diagnostic request.
DocumentDiagnosticReportKind
The document diagnostic report kinds.
DocumentDiagnosticReportPartialResult
A partial result for a document diagnostic report.
DocumentFormattingClientCapabilities
Client capabilities of a DocumentFormattingRequest.
DocumentFormattingOptions
Provider options for a DocumentFormattingRequest.
DocumentFormattingParams
The parameters of a DocumentFormattingRequest.
DocumentFormattingRegistrationOptions
Registration options for a 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 DocumentHighlightRequest.
DocumentHighlightKind
A document highlight kind.
DocumentHighlightOptions
Provider options for a DocumentHighlightRequest.
DocumentHighlightParams
Parameters for a DocumentHighlightRequest.
DocumentHighlightRegistrationOptions
Registration options for a DocumentHighlightRequest.
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 DocumentLinkRequest.
DocumentLinkOptions
Provider options for a DocumentLinkRequest.
DocumentLinkParams
The parameters of a DocumentLinkRequest.
DocumentLinkRegistrationOptions
Registration options for a DocumentLinkRequest.
DocumentOnTypeFormattingClientCapabilities
Client capabilities of a DocumentOnTypeFormattingRequest.
DocumentOnTypeFormattingOptions
Provider options for a DocumentOnTypeFormattingRequest.
DocumentOnTypeFormattingParams
The parameters of a DocumentOnTypeFormattingRequest.
DocumentOnTypeFormattingRegistrationOptions
Registration options for a DocumentOnTypeFormattingRequest.
DocumentRangeFormattingClientCapabilities
Client capabilities of a DocumentRangeFormattingRequest.
DocumentRangeFormattingOptions
Provider options for a DocumentRangeFormattingRequest.
DocumentRangeFormattingParams
The parameters of a DocumentRangeFormattingRequest.
DocumentRangeFormattingRegistrationOptions
Registration options for a DocumentRangeFormattingRequest.
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 DocumentSymbolRequest.
DocumentSymbolClientCapabilitiesSymbolKind
DocumentSymbolClientCapabilitiesTagSupport
DocumentSymbolOptions
Provider options for a DocumentSymbolRequest.
DocumentSymbolParams
Parameters for a DocumentSymbolRequest.
DocumentSymbolRegistrationOptions
Registration options for a DocumentSymbolRequest.
Either2<T1, T2>
Either3<T1, T2, T3>
Either4<T1, T2, T3, T4>
ErrorCodes
Predefined error codes.
ErrorOr<T>
ExecuteCommandClientCapabilities
The client capabilities of a ExecuteCommandRequest.
ExecuteCommandOptions
The server capabilities of a ExecuteCommandRequest.
ExecuteCommandParams
The parameters of a ExecuteCommandRequest.
ExecuteCommandRegistrationOptions
Registration options for a ExecuteCommandRequest.
ExecutionSummary
FailureHandlingKind
FileChangeType
The file event type
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.
FileOperationPatternKind
A pattern kind describing if a glob pattern matches a file a folder or both.
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
FoldingRangeClientCapabilitiesFoldingRange
FoldingRangeClientCapabilitiesFoldingRangeKind
FoldingRangeKind
A set of predefined range kinds.
FoldingRangeOptions
FoldingRangeParams
Parameters for a FoldingRangeRequest.
FoldingRangeRegistrationOptions
FormattingOptions
Value-object describing what options formatting should use.
FullDocumentDiagnosticReport
A diagnostic report with a full set of problems.
GeneralClientCapabilities
General client capabilities.
GeneralClientCapabilitiesStaleRequestSupport
Hover
The result of a hover request.
HoverClientCapabilities
HoverOptions
Hover options.
HoverParams
Parameters for a HoverRequest.
HoverRegistrationOptions
Registration options for a HoverRequest.
ImplementationClientCapabilities
@since 3.6.0
ImplementationOptions
ImplementationParams
ImplementationRegistrationOptions
InitializedParams
InitializeParams
The initialize parameters
InitializeParamsClientInfo
InitializeResult
The result returned from an initialize request.
InitializeResultServerInfo
InlayHint
Inlay hint information.
InlayHintClientCapabilities
Inlay hint client capabilities.
InlayHintClientCapabilitiesResolveSupport
InlayHintKind
Inlay hint kinds.
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.
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.
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.
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.
Represents the connection of two locations. Provides additional metadata over normal Location, including an origin range.
LogMessageParams
The log message parameters.
LogTraceParams
LspJsonHandler<T>
A helper to allow handlers to declare both a JSON validation function and parse function.
MarkdownClientCapabilities
Client capabilities specific to the used markdown parser.
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.
MarkupKind
Describes the content type that a client supports in various result literals like Hover, ParameterInfo or CompletionItem.
MessageActionItem
MessageType
The message type
Method
All standard LSP Methods read from the JSON spec.
Moniker
Moniker definition to match LSIF 0.5 moniker definition.
MonikerClientCapabilities
Client capabilities specific to the moniker request.
MonikerKind
The moniker kind.
MonikerOptions
MonikerParams
MonikerRegistrationOptions
NotebookCell
A notebook cell.
NotebookCellArrayChange
A change describing how to move a NotebookCell array from state S to S'.
NotebookCellKind
A notebook cell kind.
NotebookCellTextDocumentFilter
A notebook cell text document filter denotes a cell text document by different properties.
NotebookDocument
A notebook document.
NotebookDocumentChangeEvent
A change event for a notebook document.
NotebookDocumentChangeEventCells
NotebookDocumentChangeEventCellsStructure
NotebookDocumentChangeEventCellsTextContent
NotebookDocumentClientCapabilities
Capabilities specific to the notebook document support.
NotebookDocumentFilter1
NotebookDocumentFilter2
NotebookDocumentFilter3
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.
NotebookDocumentSyncOptionsNotebookSelector
NotebookDocumentSyncOptionsNotebookSelector2
NotebookDocumentSyncOptionsNotebookSelector2Cells
NotebookDocumentSyncOptionsNotebookSelectorCells
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.
PartialResultParams
PlaceholderAndRange
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.
PositionEncodingKind
A set of predefined position encoding kinds.
PrepareRenameParams
PrepareRenameResult2
PrepareSupportDefaultBehavior
PreviousResultId
A previous result id in a workspace pull request.
ProgressParams
PublishDiagnosticsClientCapabilities
The publish diagnostic client capabilities.
PublishDiagnosticsClientCapabilitiesTagSupport
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 ReferencesRequest.
ReferenceContext
Value-object that contains additional information when requesting references.
ReferenceOptions
Reference options.
ReferenceParams
Parameters for a ReferencesRequest.
ReferenceRegistrationOptions
Registration options for a 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 RenameRequest.
RenameParams
The parameters of a RenameRequest.
RenameRegistrationOptions
Registration options for a RenameRequest.
ResourceOperation
A generic resource operation.
ResourceOperationKind
SaveOptions
Save options.
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
SemanticTokenModifiers
A set of predefined token modifiers. This set is not fixed an clients can specify additional token types via the corresponding client capabilities.
SemanticTokens
@since 3.16.0
SemanticTokensClientCapabilities
@since 3.16.0
SemanticTokensClientCapabilitiesRequests
SemanticTokensClientCapabilitiesRequestsFull
SemanticTokensClientCapabilitiesRequestsRange
SemanticTokensDelta
@since 3.16.0
SemanticTokensDeltaParams
@since 3.16.0
SemanticTokensDeltaPartialResult
@since 3.16.0
SemanticTokensEdit
@since 3.16.0
SemanticTokensLegend
@since 3.16.0
SemanticTokensOptions
@since 3.16.0
SemanticTokensOptionsFull
SemanticTokensOptionsRange
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
SemanticTokenTypes
A set of predefined token types. This set is not fixed an clients can specify additional token types via the corresponding client capabilities.
ServerCapabilities
Defines the capabilities provided by a language server.
ServerCapabilitiesWorkspace
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
ShowMessageRequestClientCapabilitiesMessageActionItem
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 SignatureHelpRequest.
SignatureHelpClientCapabilitiesSignatureInformation
SignatureHelpContext
Additional information about the context in which a signature help request was triggered.
SignatureHelpOptions
Server Capabilities for a SignatureHelpRequest.
SignatureHelpParams
Parameters for a SignatureHelpRequest.
SignatureHelpRegistrationOptions
Registration options for a SignatureHelpRequest.
SignatureHelpTriggerKind
How a signature help was triggered.
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.
SignatureInformationParameterInformation
StaticRegistrationOptions
Static registration options to be returned in the initialize request.
SymbolInformation
Represents information about programming constructs like variables, classes, interfaces etc.
SymbolKind
A symbol kind.
SymbolTag
Symbol tags are extra annotations that tweak the rendering of a symbol.
TextDocumentChangeRegistrationOptions
Describe options to be used when registered for text document change events.
TextDocumentClientCapabilities
Text document specific client capabilities.
TextDocumentContentChangeEvent1
TextDocumentContentChangeEvent2
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.
TextDocumentFilter1
TextDocumentFilter3
TextDocumentFilterWithScheme
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.
TextDocumentPositionParams
A parameter literal used in requests to pass a text document and a position inside that document.
TextDocumentRegistrationOptions
General text document registration options.
TextDocumentSaveReason
Represents reasons why a text document is saved.
TextDocumentSaveRegistrationOptions
Save registration options.
TextDocumentSyncClientCapabilities
TextDocumentSyncKind
Defines how the host (editor) should sync document changes to the language server.
TextDocumentSyncOptions
TextEdit
A text edit applicable to a text document.
ToJsonable
TokenFormat
TraceValues
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.
UniquenessLevel
Moniker uniqueness level to define scope of the moniker.
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.
WatchKind
WillSaveTextDocumentParams
The parameters sent in a will save text document notification.
WindowClientCapabilities
WorkDoneProgressBegin
WorkDoneProgressCancelParams
WorkDoneProgressCreateParams
WorkDoneProgressEnd
WorkDoneProgressOptions
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
WorkspaceEditClientCapabilitiesChangeAnnotationSupport
WorkspaceFolder
A workspace folder inside a client.
WorkspaceFoldersChangeEvent
The workspace folder change event.
WorkspaceFoldersServerCapabilities
WorkspaceFullDocumentDiagnosticReport
A full document diagnostic report for a workspace diagnostic result.
WorkspaceSymbol
A special workspace symbol that supports locations without a range.
WorkspaceSymbolClientCapabilities
Client capabilities for a WorkspaceSymbolRequest.
WorkspaceSymbolClientCapabilitiesResolveSupport
WorkspaceSymbolClientCapabilitiesSymbolKind
WorkspaceSymbolClientCapabilitiesTagSupport
WorkspaceSymbolLocation
WorkspaceSymbolOptions
Server capabilities for a WorkspaceSymbolRequest.
WorkspaceSymbolParams
The parameters of a WorkspaceSymbolRequest.
WorkspaceSymbolRegistrationOptions
Registration options for a WorkspaceSymbolRequest.
WorkspaceUnchangedDocumentDiagnosticReport
An unchanged document diagnostic report for a workspace diagnostic result.

Extensions

IncomingMessageExtension on IncomingMessage

Functions

cancelled<R>() → ErrorOr<R>
error<R>(ErrorCodes code, String message, [String? data]) → ErrorOr<R>
failure<R>(ErrorOr error) → ErrorOr<R>
lspEquals(dynamic obj1, dynamic obj2) → bool
Returns if two objects are equal, recursively checking items in Maps/Lists.
lspHashCode(dynamic obj) → int
Returns an objects hash code, recursively combining hashes for items in Maps/Lists.
specToJson(Object? obj) → Object?
success<R>(R t) → ErrorOr<R>

Typedefs

CallHierarchyIncomingCallsResult = List<CallHierarchyIncomingCall>?
Result for a request to resolve the incoming calls for a given CallHierarchyItem.
CallHierarchyOutgoingCallsResult = List<CallHierarchyOutgoingCall>?
Result for a request to resolve the outgoing calls for a given CallHierarchyItem.
ChangeAnnotationIdentifier = String
An identifier to refer to a change annotation stored with a workspace edit.
Declaration = Either2<List<Location>, Location>
The declaration of a symbol representation as one or many Location.
Information about where a symbol is declared.
Definition = Either2<List<Location>, Location>
The definition of a symbol represented as one or many Location. For most programming languages there is only one location at which a symbol is defined.
Information about where a symbol is defined.
DocumentDiagnosticReport = Either2<RelatedFullDocumentDiagnosticReport, RelatedUnchangedDocumentDiagnosticReport>
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 = Either2<NotebookCellTextDocumentFilter, TextDocumentFilter>
A document filter describes a top level text document or a notebook cell document.
DocumentSelector = List<TextDocumentFilterWithScheme>
A document selector is the combination of one or many document filters.
GlobPattern = Either2<LspPattern, RelativePattern>
The glob pattern. Either a string pattern or a relative pattern.
InlineValue = Either3<InlineValueEvaluatableExpression, InlineValueText, InlineValueVariableLookup>
Inline value information can be provided by different means:
LSPArray = List<LSPAny?>
LSP arrays. @since 3.17.0
LspPattern = String
The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
NotebookDocumentFilter = Either3<NotebookDocumentFilter1, NotebookDocumentFilter2, NotebookDocumentFilter3>
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)
PrepareRenameResult = Either3<PlaceholderAndRange, PrepareRenameResult2, Range>
ProgressToken = Either2<int, String>
TextDocumentCodeActionResult = List<Either2<CodeAction, Command>>?
Result for a request to provide commands for the given text document and range.
TextDocumentCodeLensResult = List<CodeLens>?
Result for a request to provide code lens for the given text document.
TextDocumentCompletionResult = Either2<CompletionList, List<CompletionItem>>?
Result for request to request completion at a given text document position. The request's parameter is of type TextDocumentPosition the response is of type CompletionItem or CompletionList or a Future that resolves to such.
TextDocumentContentChangeEvent = Either2<TextDocumentContentChangeEvent1, TextDocumentContentChangeEvent2>
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.
TextDocumentDeclarationResult = Either2<Declaration, List<DeclarationLink>>?
Result for a request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type TextDocumentPositionParams the response is of type Declaration or a typed array of DeclarationLink or a Future that resolves to such.
TextDocumentDefinitionResult = Either2<Definition, List<DefinitionLink>>?
Result for a request to resolve the definition location of a symbol at a given text document position. The request's parameter is of type TextDocumentPosition the response is of either type Definition or a typed array of DefinitionLink or a Future that resolves to such.
TextDocumentDocumentHighlightResult = List<DocumentHighlight>?
Result for request to resolve a DocumentHighlight for a given text document position. The request's parameter is of type TextDocumentPosition the request response is of type DocumentHighlight or a Future that resolves to such.
TextDocumentDocumentLinkResult = List<DocumentLink>?
Result for a request to provide document links
TextDocumentDocumentSymbolResult = Either2<List<DocumentSymbol>, List<SymbolInformation>>?
Result for a request to list all symbols found in a given text document. The request's parameter is of type TextDocumentIdentifier the response is of type SymbolInformation or a Future that resolves to such.
TextDocumentFilter = Either3<TextDocumentFilter1, TextDocumentFilterWithScheme, TextDocumentFilter3>
A document filter denotes a document by different properties like the TextDocument.languageId, the Uri.scheme of its resource, or a glob-pattern that is applied to the TextDocument.fileName.
TextDocumentFoldingRangeResult = List<FoldingRange>?
Result for a request to provide folding ranges in a document. The request's parameter is of type FoldingRangeParams, the response is of type FoldingRangeList or a Future that resolves to such.
TextDocumentFormattingResult = List<TextEdit>?
Result for a request to format a whole document.
TextDocumentHoverResult = Hover?
Result for request to request hover information at a given text document position. The request's parameter is of type TextDocumentPosition the response is of type Hover or a Future that resolves to such.
TextDocumentImplementationResult = Either2<Definition, List<DefinitionLink>>?
Result for a request to resolve the implementation locations of a symbol at a given text document position. The request's parameter is of type TextDocumentPositionParams the response is of type Definition or a Future that resolves to such.
TextDocumentInlayHintResult = List<InlayHint>?
Result for a request to provide inlay hints in a document. The request's parameter is of type InlayHintsParams, the response is of type InlayHint or a Future that resolves to such.
TextDocumentInlineValueResult = List<InlineValue>?
Result for a request to provide inline values in a document. The request's parameter is of type InlineValueParams, the response is of type InlineValue or a Future that resolves to such.
TextDocumentLinkedEditingRangeResult = LinkedEditingRanges?
Result for a request to provide ranges that can be edited together.
TextDocumentMonikerResult = List<Moniker>?
Result for a request to get the moniker of a symbol at a given text document position. The request parameter is of type TextDocumentPositionParams. The response is of type Moniker or null.
TextDocumentOnTypeFormattingResult = List<TextEdit>?
Result for a request to format a document on type.
TextDocumentPrepareCallHierarchyResult = List<CallHierarchyItem>?
Result for a request to result a CallHierarchyItem in a document at a given position. Can be used as an input to an incoming or outgoing call hierarchy.
TextDocumentPrepareRenameResult = PrepareRenameResult?
Result for a request to test and perform the setup necessary for a rename.
TextDocumentPrepareTypeHierarchyResult = List<TypeHierarchyItem>?
Result for a request to result a TypeHierarchyItem in a document at a given position. Can be used as an input to a subtypes or supertypes type hierarchy.
TextDocumentRangeFormattingResult = List<TextEdit>?
Result for a request to format a range in a document.
TextDocumentReferencesResult = List<Location>?
Result for a request to resolve project-wide references for the symbol denoted by the given text document position. The request's parameter is of type ReferenceParams the response is of type Location or a Future that resolves to such.
TextDocumentRenameResult = WorkspaceEdit?
Result for a request to rename a symbol.
TextDocumentSelectionRangeResult = List<SelectionRange>?
Result for a request to provide selection ranges in a document. The request's parameter is of type SelectionRangeParams, the response is of type SelectionRange or a Future that resolves to such.
TextDocumentSemanticTokensFullDeltaResult = Either2<SemanticTokens, SemanticTokensDelta>?
Result for @since 3.16.0
TextDocumentSemanticTokensFullResult = SemanticTokens?
Result for @since 3.16.0
TextDocumentSemanticTokensRangeResult = SemanticTokens?
Result for @since 3.16.0
TextDocumentSignatureHelpResult = SignatureHelp?
TextDocumentTypeDefinitionResult = Either2<Definition, List<DefinitionLink>>?
Result for a request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type TextDocumentPositionParams the response is of type Definition or a Future that resolves to such.
TextDocumentWillSaveWaitUntilResult = List<TextEdit>?
Result for a document will save request is sent from the client to the server before the document is actually saved. The request can return an array of TextEdits which will be applied to the text document before it is saved. Please note that clients might drop results if computing the text edits took too long or if a server constantly fails on this request. This is done to keep the save fast and reliable.
TypeHierarchySubtypesResult = List<TypeHierarchyItem>?
Result for a request to resolve the subtypes for a given TypeHierarchyItem.
TypeHierarchySupertypesResult = List<TypeHierarchyItem>?
Result for a request to resolve the supertypes for a given TypeHierarchyItem.
WindowShowMessageRequestResult = MessageActionItem?
Result for the show message request is sent from the server to the client to show a message and a set of options actions to the user.
WorkspaceDocumentDiagnosticReport = Either2<WorkspaceFullDocumentDiagnosticReport, WorkspaceUnchangedDocumentDiagnosticReport>
A workspace diagnostic document report.
WorkspaceExecuteCommandResult = LSPAny?
Result for a request send from the client to the server to execute a command. The request might return a workspace edit which the client will apply to the workspace.
WorkspaceSymbolResult = Either2<List<SymbolInformation>, List<WorkspaceSymbol>>?
Result for a request to list project-wide symbols matching the query string given by the WorkspaceSymbolParams. The response is of type SymbolInformation or a Future that resolves to such.
WorkspaceWillCreateFilesResult = WorkspaceEdit?
Result for the will create files request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client.
WorkspaceWillDeleteFilesResult = WorkspaceEdit?
Result for the did delete files notification is sent from the client to the server when files were deleted from within the client.
WorkspaceWillRenameFilesResult = WorkspaceEdit?
Result for the will rename files request is sent from the client to the server before files are actually renamed as long as the rename is triggered from within the client.
WorkspaceWorkspaceFoldersResult = List<WorkspaceFolder>?
Result for the workspace/workspaceFolders is sent from the server to the client to fetch the open workspace folders.