Module lsp::types[][src]

Modules

traits

Structs

CodeAction

A code action represents a change that can be performed in code, e.g. to fix a problem or to refactor code.

CodeActionContext

Contains additional diagnostic information about the context in which a code action is run.

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.

Color

Represents a color in RGBA space.

ColorInformation

Represents a color range from a document.

ColorPresentation
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.

CompletionItem

A completion item represents a text snippet that is proposed to complete text that is being typed.

CompletionList

Represents a collection of completion items to be presented in the editor.

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.

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.

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.

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.

DocumentSymbolParams

Parameters for a DocumentSymbolRequest.

FormattingOptions

Value-object describing what options formatting should use.

Hover

The result of a hover request.

Location

Represents a location inside a resource, such as a line inside a text file.

MarkedString

MarkedString can be used to render human readable text. It is either a markdown string or a code-block that provides a language and a code snippet. The language identifier is semantically equal to the optional language identifier in fenced code blocks in GitHub issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting

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.

ParameterInformation

Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.

Position

Position in a text document expressed as zero-based line and character offset. The offsets are 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.

Range

A range in a text document expressed as (zero-based) start and end positions.

ReferenceContext

Value-object that contains additional information when requesting references.

SignatureHelp

Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.

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.

SymbolInformation

Represents information about programming constructs like variables, classes, interfaces etc.

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 text document.

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.

TextEdit

A text edit applicable to a text document.

VersionedTextDocumentIdentifier

An identifier to denote a specific version of a text document.

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.

WorkspaceSymbolParams

The parameters of a WorkspaceSymbolRequest.

Enums

CodeActionKind

The kind of a code action.

CompletionItemKind

The kind of a completion entry.

DiagnosticSeverity

The diagnostic's severity.

DocumentHighlightKind

A document highlight kind.

InsertTextFormat

Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.

MarkupKind

Describes the content type that a client supports in various result literals like Hover, ParameterInfo or CompletionItem.

SymbolKind

A symbol kind.

TextDocumentSaveReason

Represents reasons why a text document is saved.

Constants

EOL

Type Definitions

Definition

The definition of a symbol represented as one or many locations. For most programming languages there is only one location at which a symbol is defined. If no definition can be found null is returned.