Crate lsp_types[−][src]
Language Server Protocol types for Rust.
Based on: https://microsoft.github.io/language-server-protocol/specification
This library uses the URL crate for parsing URIs. Note that there is
some confusion on the meaning of URLs vs URIs:
http://stackoverflow.com/a/28865728/393898. According to that
information, on the classical sense of “URLs”, “URLs” are a subset of
URIs, But on the modern/new meaning of URLs, they are the same as
URIs. The important take-away aspect is that the URL crate should be
able to parse any URI, such as urn:isbn:0451450523.
Re-exports
pub use selection_range::*; |
Modules
| notification | |
| request | |
| selection_range |
Macros
| lsp_notification | |
| lsp_request |
Structs
| AnnotatedTextEdit | A special text edit with an additional change annotation. |
| ApplyWorkspaceEditParams | |
| ApplyWorkspaceEditResponse | |
| CallHierarchyIncomingCall | Represents an incoming call, e.g. a caller of a method or constructor. |
| CallHierarchyIncomingCallsParams | |
| CallHierarchyItem | |
| CallHierarchyOptions | |
| CallHierarchyOutgoingCall | Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc. |
| CallHierarchyOutgoingCallsParams | |
| CallHierarchyPrepareParams | |
| CancelParams | |
| ChangeAnnotation | Additional information that describes document changes. |
| ChangeAnnotationWorkspaceEditClientCapabilities | |
| ClientCapabilities | Where ClientCapabilities are currently empty: |
| ClientInfo | |
| CodeAction | |
| CodeActionCapabilityResolveSupport | Whether the client supports resolving additional code action
properties via a separate |
| CodeActionClientCapabilities | |
| CodeActionContext | Contains additional diagnostic information about the context in which a code action is run. |
| CodeActionDisabled | |
| CodeActionKind | |
| CodeActionKindLiteralSupport | |
| CodeActionLiteralSupport | |
| CodeActionOptions | |
| CodeActionParams | Params for the CodeActionRequest |
| CodeDescription | |
| 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. |
| CodeLensOptions | Code Lens options. |
| CodeLensParams | |
| CodeLensWorkspaceClientCapabilities | |
| Color | |
| ColorInformation | |
| ColorPresentation | |
| ColorPresentationParams | |
| ColorProviderOptions | |
| Command | Represents a reference to a command. Provides a title which will be used to represent a command in the UI. Commands are identitifed using a string identifier and the protocol currently doesn’t specify a set of well known commands. So executing a command requires some tool extension code. |
| CompletionClientCapabilities | |
| CompletionContext | |
| CompletionItem | |
| CompletionItemCapability | |
| CompletionItemCapabilityResolveSupport | |
| CompletionItemKindCapability | |
| CompletionList | Represents a collection of completion items to be presented in the editor. |
| CompletionOptions | Completion options. |
| CompletionParams | |
| CompletionRegistrationOptions | |
| ConfigurationItem | |
| ConfigurationParams | |
| CreateFile | Create file operation |
| CreateFileOptions | Options to create a file. |
| CreateFilesParams | The parameters sent in notifications/requests for user-initiated creation of files. |
| DeclarationOptions | |
| DeclarationRegistrationOptions | |
| DefinitionOptions | |
| 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. |
| 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. |
| DidChangeConfigurationParams | |
| DidChangeTextDocumentParams | |
| DidChangeWatchedFilesParams | |
| DidChangeWatchedFilesRegistrationOptions | Describe options to be used when registered for text document change events. |
| DidChangeWorkspaceFoldersParams | |
| DidCloseTextDocumentParams | |
| DidOpenTextDocumentParams | |
| DidSaveTextDocumentParams | |
| DocumentColorParams | |
| DocumentFilter | A document filter denotes a document through properties like language, schema or pattern. Examples are a filter that applies to TypeScript files on disk or a filter the applies to JSON files with name package.json: |
| DocumentFormattingOptions | |
| DocumentFormattingParams | |
| 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. |
| DocumentHighlightOptions | |
| DocumentHighlightParams | |
| 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 | |
| DocumentLinkOptions | |
| DocumentLinkParams | |
| DocumentOnTypeFormattingOptions | Format document on type options |
| DocumentOnTypeFormattingParams | |
| DocumentOnTypeFormattingRegistrationOptions | Extends TextDocumentRegistrationOptions |
| DocumentRangeFormattingOptions | |
| DocumentRangeFormattingParams | |
| 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 | |
| DocumentSymbolOptions | |
| DocumentSymbolParams | |
| DynamicRegistrationClientCapabilities | |
| ExecuteCommandOptions | Execute command options. |
| ExecuteCommandParams | |
| ExecuteCommandRegistrationOptions | Execute command registration options. |
| FileCreate | Represents information on a file/folder create. |
| FileDelete | Represents information on a file/folder delete. |
| FileEvent | An event describing a file change. |
| FileOperationFilter | A filter to describe in which file operation requests or notifications the server is interested in. |
| FileOperationPattern | A pattern to describe in which file operation requests or notifications the server is interested in. |
| 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 | |
| FoldingProviderOptions | |
| FoldingRange | Represents a folding range. |
| FoldingRangeClientCapabilities | |
| FoldingRangeParams | |
| FormattingOptions | Value-object describing what options formatting should use. |
| GeneralClientCapabilities | |
| GenericOptions | |
| GenericParams | |
| GenericRegistrationOptions | |
| GotoCapability | |
| GotoDefinitionParams | |
| Hover | The result of a hover request. |
| HoverClientCapabilities | |
| HoverOptions | Hover options. |
| HoverParams | |
| HoverRegistrationOptions | |
| InitializeError | |
| InitializeParams | |
| InitializeResult | |
| InitializedParams | |
| InsertReplaceEdit | A special text edit to provide an insert and a replace operation. |
| InsertTextModeSupport | |
| LanguageString | |
| LinkedEditingRangeOptions | |
| LinkedEditingRangeParams | |
| LinkedEditingRangeRegistrationOptions | |
| LinkedEditingRanges | |
| Location | Represents a location inside a resource, such as a line inside a text file. |
| LocationLink | Represents a link between a source and a target location. |
| LogMessageParams | |
| MarkdownClientCapabilities | |
| MarkupContent | A |
| MessageActionItem | |
| MessageActionItemCapabilities | |
| Moniker | Moniker definition to match LSIF 0.5 moniker definition. |
| MonikerOptions | |
| MonikerParams | |
| MonikerRegistrationOptions | |
| OptionalVersionedTextDocumentIdentifier | An identifier which optionally denotes a specific version of a text document. This information usually flows from the server to the client |
| ParameterInformation | Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment. |
| ParameterInformationSettings | |
| PartialResultParams | A parameter literal used to pass a partial result token. |
| Position | Position in a text document expressed as zero-based line and character offset. A position is between two characters like an ‘insert’ cursor in a editor. |
| ProgressParams | The progress notification is sent from the server to the client to ask the client to indicate progress. |
| PublishDiagnosticsClientCapabilities | |
| PublishDiagnosticsParams | |
| Range | A range in a text document expressed as (zero-based) start and end positions. A range is comparable to a selection in an editor. Therefore the end position is exclusive. |
| ReferenceContext | |
| ReferenceParams | |
| ReferencesOptions | |
| Registration | General parameters to to register for a capability. |
| RegistrationParams | |
| RegularExpressionsClientCapabilities | |
| RenameClientCapabilities | |
| RenameFile | Rename file operation |
| RenameFileOptions | Rename file options |
| RenameFilesParams | The parameters sent in notifications/requests for user-initiated renames of files. |
| RenameOptions | |
| RenameParams | |
| SaveOptions | Save options. |
| SemanticToken | The actual tokens. For a detailed description about how the data is structured please see https://github.com/microsoft/vscode-extension-samples/blob/5ae1f7787122812dcc84e37427ca90af5ee09f14/semantic-tokens-sample/vscode.proposed.d.ts#L71 |
| SemanticTokenModifier | A set of predefined token modifiers. This set is not fixed and clients can specify additional token types via the corresponding client capabilities. |
| SemanticTokenType | A set of predefined token types. This set is not fixed and clients can specify additional token types via the corresponding client capabilities. |
| SemanticTokens | @since 3.16.0 |
| SemanticTokensClientCapabilities | Capabilities specific to the |
| SemanticTokensClientCapabilitiesRequests | |
| SemanticTokensDelta | @since 3.16.0 |
| SemanticTokensDeltaParams | |
| SemanticTokensEdit | @since 3.16.0 |
| SemanticTokensLegend | @since 3.16.0 |
| SemanticTokensOptions | @since 3.16.0 |
| SemanticTokensParams | |
| SemanticTokensPartialResult | @since 3.16.0 |
| SemanticTokensRangeParams | |
| SemanticTokensRegistrationOptions | |
| SemanticTokensWorkspaceClientCapabilities | |
| ServerCapabilities | |
| ServerInfo | |
| ShowDocumentClientCapabilities | Client capabilities for the show document request. |
| ShowDocumentParams | Params to show a document. |
| ShowDocumentResult | The result of an show document request. |
| ShowMessageParams | |
| 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 | |
| SignatureHelpContext | |
| SignatureHelpOptions | Signature help options. |
| SignatureHelpParams | |
| SignatureHelpRegistrationOptions | Signature help options. |
| 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. |
| SignatureInformationSettings | |
| StaticRegistrationOptions | |
| StaticTextDocumentColorProviderOptions | |
| StaticTextDocumentRegistrationOptions | |
| SymbolInformation | Represents information about programming constructs like variables, classes, interfaces etc. |
| SymbolKindCapability | Specific capabilities for the |
| TagSupport | |
| TextDocumentChangeRegistrationOptions | Descibe options to be used when registered for text document change events. |
| TextDocumentClientCapabilities | Text document specific client capabilities. |
| TextDocumentContentChangeEvent | An event describing a change to a text document. If range and rangeLength are omitted the new text is considered to be the full content of the document. |
| TextDocumentEdit | Describes textual changes on a single text document. The text document is referred to as a
|
| TextDocumentIdentifier | Text documents are identified using a URI. On the protocol level, URIs are passed as strings. |
| 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 | Since most of the registration options require to specify a document selector there is a base interface that can be used. |
| TextDocumentSaveRegistrationOptions | |
| TextDocumentSyncClientCapabilities | |
| TextDocumentSyncOptions | |
| TextEdit | A textual edit applicable to a text document. |
| TokenFormat | |
| Unregistration | General parameters to unregister a capability. |
| UnregistrationParams | |
| Url | A parsed URL record. |
| VersionedTextDocumentIdentifier | An identifier to denote a specific version of a text document. This information usually flows from the client to the server. |
| WatchKind | |
| WillSaveTextDocumentParams | The parameters send in a will save text document notification. |
| WindowClientCapabilities | Window specific client capabilities. |
| WorkDoneProgressBegin | |
| WorkDoneProgressCancelParams | The |
| WorkDoneProgressCreateParams | The |
| WorkDoneProgressEnd | |
| WorkDoneProgressOptions | |
| WorkDoneProgressParams | An optional token that a server can use to report work done progress |
| WorkDoneProgressReport | |
| WorkspaceClientCapabilities | Workspace specific client capabilities. |
| WorkspaceEdit | A workspace edit represents changes to many resources managed in the workspace.
The edit should either provide |
| WorkspaceEditClientCapabilities | |
| WorkspaceFileOperationsClientCapabilities | |
| WorkspaceFileOperationsServerCapabilities | |
| WorkspaceFolder | |
| WorkspaceFoldersChangeEvent | The workspace folder change event. |
| WorkspaceFoldersServerCapabilities | |
| WorkspaceServerCapabilities | |
| WorkspaceSymbolClientCapabilities | |
| WorkspaceSymbolOptions | |
| WorkspaceSymbolParams | The parameters of a Workspace Symbol Request. |
Enums
Type Definitions
| CallHierarchyClientCapabilities | |
| ChangeAnnotationIdentifier | An identifier referring to a change annotation managed by a workspace edit. |
| CodeActionResponse | response for CodeActionRequest |
| CodeLensClientCapabilities | |
| DidChangeConfigurationClientCapabilities | |
| DidChangeWatchedFilesClientCapabilities | |
| DocumentColorClientCapabilities | |
| DocumentFormattingClientCapabilities | |
| DocumentHighlightClientCapabilities | |
| DocumentOnTypeFormattingClientCapabilities | |
| DocumentRangeFormattingClientCapabilities | |
| DocumentSelector | A document selector is the combination of one or many document filters. |
| ExecuteCommandClientCapabilities | |
| LinkedEditingRangeClientCapabilities | |
| MonikerClientCapabilities | |
| ProgressToken | |
| ReferenceClientCapabilities |