View Source GenLSP.Structures.GeneralClientCapabilities (gen_lsp v0.8.1)

General client capabilities.

@since 3.16.0

Link to this section Summary

Functions

Fields

  • stale_request_support: Client capability that signals how the client handles stale requests (e.g. a request for which the client will not process the response anymore since the information is outdated).

Link to this section Types

@type t() :: %GenLSP.Structures.GeneralClientCapabilities{
  markdown: GenLSP.Structures.MarkdownClientCapabilities.t() | nil,
  position_encodings: [GenLSP.Enumerations.PositionEncodingKind.t()] | nil,
  regular_expressions:
    GenLSP.Structures.RegularExpressionsClientCapabilities.t() | nil,
  stale_request_support: map() | nil
}

Link to this section Functions

Link to this function

%GenLSP.Structures.GeneralClientCapabilities{}

View Source (struct)

fields

Fields

  • stale_request_support: Client capability that signals how the client handles stale requests (e.g. a request for which the client will not process the response anymore since the information is outdated).

    @since 3.17.0

  • regular_expressions: Client capabilities specific to regular expressions.

    @since 3.16.0

  • markdown: Client capabilities specific to the client's markdown parser.

    @since 3.16.0

  • position_encodings: The position encodings supported by the client. Client and server have to agree on the same position encoding to ensure that offsets (e.g. character position in a line) are interpreted the same on both sides.

    To keep the protocol backwards compatible the following applies: if the value 'utf-16' is missing from the array of position encodings servers can assume that the client supports UTF-16. UTF-16 is therefore a mandatory encoding.

    If omitted it defaults to ['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.

    @since 3.17.0