

GenLSP — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L1 "View Source")

GenLSP behaviour

(gen\_lsp v0.6.0)

================================================================================================================================================

GenLSP is an OTP behaviour for building processes that implement the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/).

[examples](#module-examples)

 Examples

---------------------------------------

[Credo](https://github.com/rrrene/credo) language server.

```

defmodule Credo.Lsp do

  @moduledoc """

  LSP implementation for Credo.

  """

  use GenLSP

  alias GenLSP.Enumerations.TextDocumentSyncKind

  alias GenLSP.Notifications.{

    Exit,

    Initialized,

    TextDocumentDidChange,

    TextDocumentDidClose,

    TextDocumentDidOpen,

    TextDocumentDidSave

  }

  alias GenLSP.Requests.{Initialize, Shutdown}

  alias GenLSP.Structures.{

    InitializeParams,

    InitializeResult,

    SaveOptions,

    ServerCapabilities,

    TextDocumentSyncOptions

  }

  alias Credo.Lsp.Cache, as: Diagnostics

  def start_link(args) do

    GenLSP.start_link(__MODULE__, args, [])

  end

  @impl true

  def init(lsp, args) do

    cache = Keyword.fetch!(args, :cache)

    {:ok, assign(lsp, exit_code: 1, cache: cache)}

  end

  @impl true

  def handle_request(%Initialize{params: %InitializeParams{root_uri: root_uri}}, lsp) do

    {:reply,

     %InitializeResult{

       capabilities: %ServerCapabilities{

         text_document_sync: %TextDocumentSyncOptions{

           open_close: true,

           save: %SaveOptions{include_text: true},

           change: TextDocumentSyncKind.full()

         }

       },

       server_info: %{name: "Credo"}

     }, assign(lsp, root_uri: root_uri)}

  end

  def handle_request(%Shutdown{}, lsp) do

    {:noreply, assign(lsp, exit_code: 0)}

  end

  @impl true

  def handle_notification(%Initialized{}, lsp) do

    GenLSP.log(lsp, :log, "[Credo] LSP Initialized!")

    Diagnostics.refresh(lsp.assigns.cache, lsp)

    Diagnostics.publish(lsp.assigns.cache, lsp)

    {:noreply, lsp}

  end

  def handle_notification(%TextDocumentDidSave{}, lsp) do

    Task.start_link(fn ->

      Diagnostics.clear(lsp.assigns.cache)

      Diagnostics.refresh(lsp.assigns.cache, lsp)

      Diagnostics.publish(lsp.assigns.cache, lsp)

    end)

    {:noreply, lsp}

  end

  def handle_notification(%TextDocumentDidChange{}, lsp) do

    Task.start_link(fn ->

      Diagnostics.clear(lsp.assigns.cache)

      Diagnostics.publish(lsp.assigns.cache, lsp)

    end)

    {:noreply, lsp}

  end

  def handle_notification(%note{}, lsp)

      when note in [TextDocumentDidOpen, TextDocumentDidClose] do

    {:noreply, lsp}

  end

  def handle_notification(%Exit{}, lsp) do

    System.halt(lsp.assigns.exit_code)

    {:noreply, lsp}

  end

  def handle_notification(_thing, lsp) do

    {:noreply, lsp}

  end

end

defmodule Credo.Lsp.Cache do

  @moduledoc """

  Cache for Credo diagnostics.

  """

  use Agent

  alias GenLSP.Structures.{

    Diagnostic,

    Position,

    PublishDiagnosticsParams,

    Range

  }

  alias GenLSP.Notifications.TextDocumentPublishDiagnostics

  def start_link(_) do

    Agent.start_link(fn -> Map.new() end)

  end

  def refresh(cache, lsp) do

    dir = URI.new!(lsp.assigns.root_uri).path

    issues = Credo.Execution.get_issues(Credo.run(["--strict", "--all", "#{dir}/**/*.ex"]))

    GenLSP.log(lsp, :info, "[Credo] Found #{Enum.count(issues)} issues")

    for issue <- issues do

      diagnostic = %Diagnostic{

        range: %Range{

          start: %Position{line: issue.line_no - 1, character: issue.column || 0},

          end: %Position{line: issue.line_no, character: 0}

        },

        severity: category_to_severity(issue.category),

        message: """

        #{issue.message}

        ## Explanation

        #{issue.check.explanations()[:check]}

        """

      }

      put(cache, Path.absname(issue.filename), diagnostic)

    end

  end

  def get(cache) do

    Agent.get(cache, & &1)

  end

  def put(cache, filename, diagnostic) do

    Agent.update(cache, fn cache ->

      Map.update(cache, Path.absname(filename), [diagnostic], fn v ->

        [diagnostic | v]

      end)

    end)

  end

  def clear(cache) do

    Agent.update(cache, fn cache ->

      for {k, _} <- cache, into: Map.new() do

        {k, []}

      end

    end)

  end

  def publish(cache, lsp) do

    for {file, diagnostics} <- get(cache) do

      GenLSP.notify(lsp, %TextDocumentPublishDiagnostics{

        params: %PublishDiagnosticsParams{

          uri: "file://#{file}",

          diagnostics: diagnostics

        }

      })

    end

  end

  def category_to_severity(:refactor), do: 1

  def category_to_severity(:warning), do: 2

  def category_to_severity(:design), do: 3

  def category_to_severity(:consistency), do: 4

  def category_to_severity(:readability), do: 4

end

```

[Link to this section](#summary)

 Summary

==========================================

[Callbacks](#callbacks)

------------------------

[handle\_info(message, state)](#c:handle_info/2)

The callback responsible for handling normal messages.

[handle\_notification(notification, state)](#c:handle_notification/2)

The callback responsible for handling notifications from the client.

[handle\_request(request, state)](#c:handle_request/2)

The callback responsible for handling requests from the client.

[init(lsp, init\_arg)](#c:init/2)

The callback responsible for initializing the process.

[Functions](#functions)

------------------------

[error(lsp, message)](#error/2)

Send a `window/logMessage` error notification to the client.

[info(lsp, message)](#info/2)

Send a `window/logMessage` info notification to the client.

[log(lsp, message)](#log/2)

Send a `window/logMessage` log notification to the client.

[notify(map, notification)](#notify/2)

Sends a notification to the client from the LSP process.

[notify\_server(pid, notification)](#notify_server/2)

Sends a notification from the client to the LSP process.

[request(map, request)](#request/2)

Sends a request to the client from the LSP process.

[request\_server(pid, request)](#request_server/2)

Sends a request from the client to the LSP process.

[start\_link(module, init\_args, opts)](#start_link/3)

Starts a [`GenLSP`](GenLSP.html#content) process that is linked to the current process.

[warning(lsp, message)](#warning/2)

Send a `window/logMessage` error notification to the client.

[Link to this section](#callbacks)

Callbacks

=============================================

[Link to this callback](#c:handle_info/2 "Link to this callback")

handle\_info(message, state)

============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L118 "View Source")

```

@callback handle_info(message :: [any](https://hexdocs.pm/elixir/typespecs.html#basic-types)(), state) :: {:noreply, state}

when state: [GenLSP.LSP.t](GenLSP.LSP.html#t:t/0)()

```

The callback responsible for handling normal messages.

Receives the message as the first argument and the LSP token [`GenLSP.LSP.t/0`](GenLSP.LSP.html#t:t/0) as the second.

[usage](#c:handle_info/2-usage)

 Usage

---------------------------------------

```

@impl true

def handle\_info(message, lsp) do

 # handle the message

 {:noreply, lsp}

end

```

[Link to this callback](#c:handle_notification/2 "Link to this callback")

handle\_notification(notification, state)

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L100 "View Source")

```

@callback handle_notification(notification :: [term](https://hexdocs.pm/elixir/typespecs.html#built-in-types)(), state) :: {:noreply, state}

when state: [GenLSP.LSP.t](GenLSP.LSP.html#t:t/0)()

```

The callback responsible for handling notifications from the client.

Receives the notification struct as the first argument and the LSP token [`GenLSP.LSP.t/0`](GenLSP.LSP.html#t:t/0) as the second.

[usage](#c:handle_notification/2-usage)

 Usage

-----------------------------------------------

```

@impl true

def handle\_notification(%Initialized{}, lsp) do

 # handle the notification

 {:noreply, lsp}

end

```

[Link to this callback](#c:handle_request/2 "Link to this callback")

handle\_request(request, state)

===============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L81 "View Source")

```

@callback handle_request(request :: [term](https://hexdocs.pm/elixir/typespecs.html#built-in-types)(), state) ::

  {:reply, reply :: [term](https://hexdocs.pm/elixir/typespecs.html#built-in-types)(), state} | {:noreply, state}

when state: [GenLSP.LSP.t](GenLSP.LSP.html#t:t/0)()

```

The callback responsible for handling requests from the client.

Receives the request struct as the first argument and the LSP token [`GenLSP.LSP.t/0`](GenLSP.LSP.html#t:t/0) as the second.

[usage](#c:handle_request/2-usage)

 Usage

------------------------------------------

```

@impl true

def handle\_request(%Initialize{params: %InitializeParams{root\_uri: root\_uri}}, lsp) do

 {:reply,

 %InitializeResult{

 capabilities: %ServerCapabilities{

 text\_document\_sync: %TextDocumentSyncOptions{

 open\_close: true,

 save: %SaveOptions{include\_text: true},

 change: TextDocumentSyncKind.full()

 }

 },

 server\_info: %{name: "MyLSP"}

 }, assign(lsp, root\_uri: root\_uri)}

end

```

[Link to this callback](#c:init/2 "Link to this callback")

init(lsp, init\_arg)

====================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L56 "View Source")

```

@callback init(lsp :: [GenLSP.LSP.t](GenLSP.LSP.html#t:t/0)(), init_arg :: [term](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()) :: {:ok, [GenLSP.LSP.t](GenLSP.LSP.html#t:t/0)()}

```

The callback responsible for initializing the process.

Receives the [`GenLSP.LSP.t/0`](GenLSP.LSP.html#t:t/0) token as the first argument and the arguments that were passed to [`GenLSP.start_link/3`](#start_link/3) as the second.

[usage](#c:init/2-usage)

 Usage

--------------------------------

```

@impl true

def init(lsp, args) do

 some\_arg = Keyword.fetch!(args, :some\_arg)

 {:ok, assign(lsp, static\_assign: :some\_assign, some\_arg: some\_arg)}

end

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#error/2 "Link to this function")

error(lsp, message)

===================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L365 "View Source")

```

@spec error([GenLSP.LSP.t](GenLSP.LSP.html#t:t/0)(), [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()) :: :ok

```

Send a `window/logMessage` error notification to the client.

See [`GenLSP.Enumerations.MessageType.error/0`](GenLSP.Enumerations.MessageType.html#error/0).

[usage](#error/2-usage)

 Usage

-------------------------------

```

GenLSP.error(lsp, "Failed to compiled!")

```

[Link to this function](#info/2 "Link to this function")

info(lsp, message)

==================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L397 "View Source")

```

@spec info([GenLSP.LSP.t](GenLSP.LSP.html#t:t/0)(), [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()) :: :ok

```

Send a `window/logMessage` info notification to the client.

See [`GenLSP.Enumerations.MessageType.info/0`](GenLSP.Enumerations.MessageType.html#info/0).

[usage](#info/2-usage)

 Usage

------------------------------

```

GenLSP.info(lsp, "Compilation complete!")

```

[Link to this function](#log/2 "Link to this function")

log(lsp, message)

=================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L413 "View Source")

```

@spec log([GenLSP.LSP.t](GenLSP.LSP.html#t:t/0)(), [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()) :: :ok

```

Send a `window/logMessage` log notification to the client.

See [`GenLSP.Enumerations.MessageType.log/0`](GenLSP.Enumerations.MessageType.html#log/0).

[usage](#log/2-usage)

 Usage

-----------------------------

```

GenLSP.log(lsp, "Starting compilation.")

```

[Link to this function](#notify/2 "Link to this function")

notify(map, notification)

=========================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L207 "View Source")

```

@spec notify([GenLSP.LSP.t](GenLSP.LSP.html#t:t/0)(), notification :: [any](https://hexdocs.pm/elixir/typespecs.html#basic-types)()) :: :ok

```

Sends a notification to the client from the LSP process.

[usage](#notify/2-usage)

 Usage

--------------------------------

```

GenLSP.notify(lsp, %TextDocumentPublishDiagnostics{

 params: %PublishDiagnosticsParams{

 uri: "file://#{file}",

 diagnostics: diagnostics

 }

})

```

[Link to this function](#notify_server/2 "Link to this function")

notify\_server(pid, notification)

=================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L187 "View Source")

```

@spec notify_server([pid](https://hexdocs.pm/elixir/typespecs.html#basic-types)(), message) :: message when message: [term](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

```

Sends a notification from the client to the LSP process.

Generally used by the [`GenLSP.Communication.Adapter`](GenLSP.Communication.Adapter.html) implementation to forward messages from the buffer to the LSP process.

You shouldn't need to use this to implement a language server.

[Link to this function](#request/2 "Link to this function")

request(map, request)

=====================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L224 "View Source")

```

@spec request([GenLSP.LSP.t](GenLSP.LSP.html#t:t/0)(), request :: [any](https://hexdocs.pm/elixir/typespecs.html#basic-types)()) :: [any](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

```

Sends a request to the client from the LSP process.

[usage](#request/2-usage)

 Usage

---------------------------------

```

GenLSP.request(lsp, %ClientRegisterCapability{

 id: System.unique\_integer([:positive]),

 params: params

})

```

[Link to this function](#request_server/2 "Link to this function")

request\_server(pid, request)

=============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L173 "View Source")

```

@spec request_server([pid](https://hexdocs.pm/elixir/typespecs.html#basic-types)(), message) :: message when message: [term](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

```

Sends a request from the client to the LSP process.

Generally used by the [`GenLSP.Communication.Adapter`](GenLSP.Communication.Adapter.html) implementation to forward messages from the buffer to the LSP process.

You shouldn't need to use this to implement a language server.

[Link to this function](#start_link/3 "Link to this function")

start\_link(module, init\_args, opts)

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L139 "View Source")

Starts a [`GenLSP`](GenLSP.html#content) process that is linked to the current process.

[options](#start_link/3-options)

 Options

------------------------------------------

* `:buffer` - The [`pid/0`](https://hexdocs.pm/elixir/typespecs.html#basic-types) or name of the [`GenLSP.Buffer`](GenLSP.Buffer.html) process.

* `:name` ([`atom/0`](https://hexdocs.pm/elixir/typespecs.html#basic-types)) - Used for name registration as described in the "Name registration" section in the documentation for [`GenServer`](https://hexdocs.pm/elixir/GenServer.html).

[Link to this function](#warning/2 "Link to this function")

warning(lsp, message)

=====================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp.ex#L381 "View Source")

```

@spec warning([GenLSP.LSP.t](GenLSP.LSP.html#t:t/0)(), [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()) :: :ok

```

Send a `window/logMessage` error notification to the client.

See [`GenLSP.Enumerations.MessageType.warning/0`](GenLSP.Enumerations.MessageType.html#warning/0).

[usage](#warning/2-usage)

 Usage

---------------------------------

```

GenLSP.warning(lsp, "Variable `foo` is unused.")

```





GenLSP.BaseTypes — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/base_types.ex#L2 "View Source")

GenLSP.BaseTypes

(gen\_lsp v0.6.0)

====================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[document\_uri()](#t:document_uri/0)

[null()](#t:null/0)

[uinteger()](#t:uinteger/0)

[uri()](#t:uri/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:document_uri/0 "Link to this type")

document\_uri()

===============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/base_types.ex#L4 "View Source")

```

@type document_uri() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this type](#t:null/0 "Link to this type")

null()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/base_types.ex#L6 "View Source")

```

@type null() :: nil

```

[Link to this type](#t:uinteger/0 "Link to this type")

uinteger()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/base_types.ex#L5 "View Source")

```

@type uinteger() :: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

```

[Link to this type](#t:uri/0 "Link to this type")

uri()

=====

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/base_types.ex#L3 "View Source")

```

@type uri() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```





GenLSP.Buffer — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/buffer.ex#L1 "View Source")

GenLSP.Buffer

(gen\_lsp v0.6.0)

====================================================================================================================================================

The data buffer between the LSP process and the communication channel.

[Link to this section](#summary)

 Summary

==========================================

[Functions](#functions)

------------------------

[child\_spec(init\_arg)](#child_spec/1)

Returns a specification to start this module under a supervisor.

[start\_link(opts)](#start_link/1)

Starts a [`GenLSP.Buffer`](GenLSP.Buffer.html#content) process that is linked to the current process.

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#child_spec/1 "Link to this function")

child\_spec(init\_arg)

======================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/buffer.ex#L5 "View Source")

Returns a specification to start this module under a supervisor.

See [`Supervisor`](https://hexdocs.pm/elixir/Supervisor.html).

[Link to this function](#start_link/1 "Link to this function")

start\_link(opts)

=================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/buffer.ex#L30 "View Source")

Starts a [`GenLSP.Buffer`](GenLSP.Buffer.html#content) process that is linked to the current process.

[options](#start_link/1-options)

 Options

------------------------------------------

* `:communication` - A `{module, args}` tuple, where `module` implements the [`GenLSP.Communication.Adapter`](GenLSP.Communication.Adapter.html) behaviour. The default value is `{GenLSP.Communication.Stdio, []}`.

* `:name` ([`atom/0`](https://hexdocs.pm/elixir/typespecs.html#basic-types)) - Used for name registration as described in the "Name registration" section in the documentation for [`GenServer`](https://hexdocs.pm/elixir/GenServer.html).





GenLSP.Communication.Adapter — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/communication/adapter.ex#L1 "View Source")

GenLSP.Communication.Adapter behaviour

(gen\_lsp v0.6.0)

============================================================================================================================================================================================

Behaviour for implementing communication adapters for the [`GenLSP.Buffer`](GenLSP.Buffer.html) module to use.

Existing implementations:

* [`GenLSP.Communication.Stdio`](GenLSP.Communication.Stdio.html)

* [`GenLSP.Communication.TCP`](GenLSP.Communication.TCP.html)

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[state()](#t:state/0)

[Callbacks](#callbacks)

------------------------

[init(args)](#c:init/1)

Initialize the adapter.

[listen(state)](#c:listen/1)

Tells the adapter to begin listening for data.

[read(state, t)](#c:read/2)

Read from the client.

[write(body, state)](#c:write/2)

Write data to the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:state/0 "Link to this type")

state()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/communication/adapter.ex#L10 "View Source")

```

@type state() :: [any](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

```

[Link to this section](#callbacks)

Callbacks

=============================================

[Link to this callback](#c:init/1 "Link to this callback")

init(args)

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/communication/adapter.ex#L17 "View Source")

```

@callback init(args :: [any](https://hexdocs.pm/elixir/typespecs.html#basic-types)()) :: {:ok, [state](#t:state/0)()}

```

Initialize the adapter.

Here you should return any state that should be passed into the other callbacks.

[Link to this callback](#c:listen/1 "Link to this callback")

listen(state)

=============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/communication/adapter.ex#L34 "View Source")

```

@callback listen([state](#t:state/0)()) :: {:ok, [state](#t:state/0)()}

```

Tells the adapter to begin listening for data.

[Link to this callback](#c:read/2 "Link to this callback")

read(state, t)

==============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/communication/adapter.ex#L25 "View Source")

```

@callback read([state](#t:state/0)(), [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()) :: {:ok, [term](https://hexdocs.pm/elixir/typespecs.html#built-in-types)(), [term](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()} | :eof | {:error, [term](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()}

```

Read from the client.

This callback should read a packet of data from the client and return it as the second element in the tuple.

The third element can be used to return any data that as already been read from the client but still needs to be parsed into a packet.

[Link to this callback](#c:write/2 "Link to this callback")

write(body, state)

==================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/communication/adapter.ex#L29 "View Source")

```

@callback write(body :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(), [state](#t:state/0)()) :: :ok | {:error, [term](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()}

```

Write data to the client.





GenLSP.Communication.Stdio — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/communication/stdio.ex#L1 "View Source")

GenLSP.Communication.Stdio

(gen\_lsp v0.6.0)

==============================================================================================================================================================================

The Standard IO adapter.

This is the default adapter, and is the communication channel that most LSP clients expect to be able to use.





GenLSP.Communication.TCP — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/communication/tcp.ex#L1 "View Source")

GenLSP.Communication.TCP

(gen\_lsp v0.6.0)

==========================================================================================================================================================================

The TCP adapter.

This adapter can be used to launch the LSP with a given port and can be connected to by multiple clients.

This adapter is also used during test by [`GenLSP.Test`](GenLSP.Test.html).





GenLSP.Enumerations.CodeActionKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_kind.ex#L2 "View Source")

GenLSP.Enumerations.CodeActionKind

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

A set of predefined code action kinds

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[empty()](#empty/0)

Empty kind.

[quick\_fix()](#quick_fix/0)

Base kind for quickfix actions: 'quickfix'

[refactor()](#refactor/0)

Base kind for refactoring actions: 'refactor'

[refactor\_extract()](#refactor_extract/0)

Base kind for refactoring extraction actions: 'refactor.extract'

[refactor\_inline()](#refactor_inline/0)

Base kind for refactoring inline actions: 'refactor.inline'

[refactor\_rewrite()](#refactor_rewrite/0)

Base kind for refactoring rewrite actions: 'refactor.rewrite'

[source()](#source/0)

Base kind for source actions: `source`

[source\_fix\_all()](#source_fix_all/0)

Base kind for auto-fix source actions: `source.fixAll`.

[source\_organize\_imports()](#source_organize_imports/0)

Base kind for an organize imports source action: `source.organizeImports`

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_kind.ex#L7 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#empty/0 "Link to this function")

empty()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_kind.ex#L15 "View Source")

```

@spec empty() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Empty kind.

[Link to this function](#quick_fix/0 "Link to this function")

quick\_fix()

============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_kind.ex#L21 "View Source")

```

@spec quick_fix() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Base kind for quickfix actions: 'quickfix'

[Link to this function](#refactor/0 "Link to this function")

refactor()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_kind.ex#L27 "View Source")

```

@spec refactor() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Base kind for refactoring actions: 'refactor'

[Link to this function](#refactor_extract/0 "Link to this function")

refactor\_extract()

===================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_kind.ex#L41 "View Source")

```

@spec refactor_extract() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Base kind for refactoring extraction actions: 'refactor.extract'

Example extract actions:

* Extract method

* Extract function

* Extract variable

* Extract interface from class

* ...

[Link to this function](#refactor_inline/0 "Link to this function")

refactor\_inline()

==================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_kind.ex#L54 "View Source")

```

@spec refactor_inline() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Base kind for refactoring inline actions: 'refactor.inline'

Example inline actions:

* Inline function

* Inline variable

* Inline constant

* ...

[Link to this function](#refactor_rewrite/0 "Link to this function")

refactor\_rewrite()

===================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_kind.ex#L69 "View Source")

```

@spec refactor_rewrite() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Base kind for refactoring rewrite actions: 'refactor.rewrite'

Example rewrite actions:

* Convert JavaScript function to class

* Add or remove parameter

* Encapsulate field

* Make method static

* Move method to base class

* ...

[Link to this function](#source/0 "Link to this function")

source()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_kind.ex#L77 "View Source")

```

@spec source() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Base kind for source actions: `source`

Source code actions apply to the entire file.

[Link to this function](#source_fix_all/0 "Link to this function")

source\_fix\_all()

==================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_kind.ex#L94 "View Source")

```

@spec source_fix_all() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Base kind for auto-fix source actions: `source.fixAll`.

Fix all actions automatically fix errors that have a clear fix that do not require user input.

They should not suppress errors or perform unsafe fixes such as generating new types or classes.

@since 3.15.0

[Link to this function](#source_organize_imports/0 "Link to this function")

source\_organize\_imports()

===========================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_kind.ex#L83 "View Source")

```

@spec source_organize_imports() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Base kind for an organize imports source action: `source.organizeImports`





GenLSP.Enumerations.CodeActionTriggerKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_trigger_kind.ex#L2 "View Source")

GenLSP.Enumerations.CodeActionTriggerKind

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================

The reason why code actions were requested.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[automatic()](#automatic/0)

Code actions were requested automatically.

[invoked()](#invoked/0)

Code actions were explicitly requested by the user or by an extension.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_trigger_kind.ex#L9 "View Source")

```

@type t() :: 1 | 2

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#automatic/0 "Link to this function")

automatic()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_trigger_kind.ex#L26 "View Source")

```

@spec automatic() :: 2

```

Code actions were requested automatically.

This typically happens when current selection in a file changes, but can

also be triggered when file content changes.

[Link to this function](#invoked/0 "Link to this function")

invoked()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/code_action_trigger_kind.ex#L17 "View Source")

```

@spec invoked() :: 1

```

Code actions were explicitly requested by the user or by an extension.





GenLSP.Enumerations.CompletionItemKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L2 "View Source")

GenLSP.Enumerations.CompletionItemKind

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

The kind of a completion entry.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[class()](#class/0)

[color()](#color/0)

[constant()](#constant/0)

[constructor()](#constructor/0)

[enum()](#enum/0)

[enum\_member()](#enum_member/0)

[event()](#event/0)

[field()](#field/0)

[file()](#file/0)

[folder()](#folder/0)

[function()](#function/0)

[interface()](#interface/0)

[keyword()](#keyword/0)

[method()](#method/0)

[module()](#module/0)

[operator()](#operator/0)

[property()](#property/0)

[reference()](#reference/0)

[snippet()](#snippet/0)

[struct()](#struct/0)

[text()](#text/0)

[type\_parameter()](#type_parameter/0)

[unit()](#unit/0)

[value()](#value/0)

[variable()](#variable/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L7 "View Source")

```

@type t() ::

  1

  | 2

  | 3

  | 4

  | 5

  | 6

  | 7

  | 8

  | 9

  | 10

  | 11

  | 12

  | 13

  | 14

  | 15

  | 16

  | 17

  | 18

  | 19

  | 20

  | 21

  | 22

  | 23

  | 24

  | 25

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#class/0 "Link to this function")

class()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L55 "View Source")

```

@spec class() :: 7

```

[Link to this function](#color/0 "Link to this function")

color()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L82 "View Source")

```

@spec color() :: 16

```

[Link to this function](#constant/0 "Link to this function")

constant()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L97 "View Source")

```

@spec constant() :: 21

```

[Link to this function](#constructor/0 "Link to this function")

constructor()

=============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L46 "View Source")

```

@spec constructor() :: 4

```

[Link to this function](#enum/0 "Link to this function")

enum()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L73 "View Source")

```

@spec enum() :: 13

```

[Link to this function](#enum_member/0 "Link to this function")

enum\_member()

==============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L94 "View Source")

```

@spec enum_member() :: 20

```

[Link to this function](#event/0 "Link to this function")

event()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L103 "View Source")

```

@spec event() :: 23

```

[Link to this function](#field/0 "Link to this function")

field()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L49 "View Source")

```

@spec field() :: 5

```

[Link to this function](#file/0 "Link to this function")

file()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L85 "View Source")

```

@spec file() :: 17

```

[Link to this function](#folder/0 "Link to this function")

folder()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L91 "View Source")

```

@spec folder() :: 19

```

[Link to this function](#function/0 "Link to this function")

function()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L43 "View Source")

```

@spec function() :: 3

```

[Link to this function](#interface/0 "Link to this function")

interface()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L58 "View Source")

```

@spec interface() :: 8

```

[Link to this function](#keyword/0 "Link to this function")

keyword()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L76 "View Source")

```

@spec keyword() :: 14

```

[Link to this function](#method/0 "Link to this function")

method()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L40 "View Source")

```

@spec method() :: 2

```

[Link to this function](#module/0 "Link to this function")

module()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L61 "View Source")

```

@spec module() :: 9

```

[Link to this function](#operator/0 "Link to this function")

operator()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L106 "View Source")

```

@spec operator() :: 24

```

[Link to this function](#property/0 "Link to this function")

property()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L64 "View Source")

```

@spec property() :: 10

```

[Link to this function](#reference/0 "Link to this function")

reference()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L88 "View Source")

```

@spec reference() :: 18

```

[Link to this function](#snippet/0 "Link to this function")

snippet()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L79 "View Source")

```

@spec snippet() :: 15

```

[Link to this function](#struct/0 "Link to this function")

struct()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L100 "View Source")

```

@spec struct() :: 22

```

[Link to this function](#text/0 "Link to this function")

text()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L37 "View Source")

```

@spec text() :: 1

```

[Link to this function](#type_parameter/0 "Link to this function")

type\_parameter()

=================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L109 "View Source")

```

@spec type_parameter() :: 25

```

[Link to this function](#unit/0 "Link to this function")

unit()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L67 "View Source")

```

@spec unit() :: 11

```

[Link to this function](#value/0 "Link to this function")

value()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L70 "View Source")

```

@spec value() :: 12

```

[Link to this function](#variable/0 "Link to this function")

variable()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_kind.ex#L52 "View Source")

```

@spec variable() :: 6

```





GenLSP.Enumerations.CompletionItemTag — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_tag.ex#L2 "View Source")

GenLSP.Enumerations.CompletionItemTag

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

Completion item tags are extra annotations that tweak the rendering of a completion

item.

@since 3.15.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[deprecated()](#deprecated/0)

Render a completion as obsolete, usually using a strike-out.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_tag.ex#L10 "View Source")

```

@type t() :: 1

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#deprecated/0 "Link to this function")

deprecated()

============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_item_tag.ex#L18 "View Source")

```

@spec deprecated() :: 1

```

Render a completion as obsolete, usually using a strike-out.





GenLSP.Enumerations.CompletionTriggerKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_trigger_kind.ex#L2 "View Source")

GenLSP.Enumerations.CompletionTriggerKind

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================

How a completion was triggered

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[invoked()](#invoked/0)

Completion was triggered by typing an identifier (24x7 code

complete), manual invocation (e.g Ctrl+Space) or via API.

[trigger\_character()](#trigger_character/0)

Completion was triggered by a trigger character specified by

the `triggerCharacters` properties of the `CompletionRegistrationOptions`.

[trigger\_for\_incomplete\_completions()](#trigger_for_incomplete_completions/0)

Completion was re-triggered as current completion list is incomplete

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_trigger_kind.ex#L7 "View Source")

```

@type t() :: 1 | 2 | 3

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#invoked/0 "Link to this function")

invoked()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_trigger_kind.ex#L16 "View Source")

```

@spec invoked() :: 1

```

Completion was triggered by typing an identifier (24x7 code

complete), manual invocation (e.g Ctrl+Space) or via API.

[Link to this function](#trigger_character/0 "Link to this function")

trigger\_character()

====================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_trigger_kind.ex#L23 "View Source")

```

@spec trigger_character() :: 2

```

Completion was triggered by a trigger character specified by

the `triggerCharacters` properties of the `CompletionRegistrationOptions`.

[Link to this function](#trigger_for_incomplete_completions/0 "Link to this function")

trigger\_for\_incomplete\_completions()

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/completion_trigger_kind.ex#L29 "View Source")

```

@spec trigger_for_incomplete_completions() :: 3

```

Completion was re-triggered as current completion list is incomplete





GenLSP.Enumerations.DiagnosticSeverity — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/diagnostic_severity.ex#L2 "View Source")

GenLSP.Enumerations.DiagnosticSeverity

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================

The diagnostic's severity.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[error()](#error/0)

Reports an error.

[hint()](#hint/0)

Reports a hint.

[information()](#information/0)

Reports an information.

[warning()](#warning/0)

Reports a warning.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/diagnostic_severity.ex#L7 "View Source")

```

@type t() :: 1 | 2 | 3 | 4

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#error/0 "Link to this function")

error()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/diagnostic_severity.ex#L15 "View Source")

```

@spec error() :: 1

```

Reports an error.

[Link to this function](#hint/0 "Link to this function")

hint()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/diagnostic_severity.ex#L33 "View Source")

```

@spec hint() :: 4

```

Reports a hint.

[Link to this function](#information/0 "Link to this function")

information()

=============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/diagnostic_severity.ex#L27 "View Source")

```

@spec information() :: 3

```

Reports an information.

[Link to this function](#warning/0 "Link to this function")

warning()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/diagnostic_severity.ex#L21 "View Source")

```

@spec warning() :: 2

```

Reports a warning.





GenLSP.Enumerations.DiagnosticTag — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/diagnostic_tag.ex#L2 "View Source")

GenLSP.Enumerations.DiagnosticTag

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================

The diagnostic tags.

@since 3.15.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[deprecated()](#deprecated/0)

Deprecated or obsolete code.

[unnecessary()](#unnecessary/0)

Unused or unnecessary code.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/diagnostic_tag.ex#L9 "View Source")

```

@type t() :: 1 | 2

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#deprecated/0 "Link to this function")

deprecated()

============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/diagnostic_tag.ex#L28 "View Source")

```

@spec deprecated() :: 2

```

Deprecated or obsolete code.

Clients are allowed to rendered diagnostics with this tag strike through.

[Link to this function](#unnecessary/0 "Link to this function")

unnecessary()

=============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/diagnostic_tag.ex#L20 "View Source")

```

@spec unnecessary() :: 1

```

Unused or unnecessary code.

Clients are allowed to render diagnostics with this tag faded out instead of having

an error squiggle.





GenLSP.Enumerations.DocumentDiagnosticReportKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/document_diagnostic_report_kind.ex#L2 "View Source")

GenLSP.Enumerations.DocumentDiagnosticReportKind

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================================

The document diagnostic report kinds.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[full()](#full/0)

A diagnostic report with a full

set of problems.

[unchanged()](#unchanged/0)

A report indicating that the last

returned report is still accurate.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/document_diagnostic_report_kind.ex#L9 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#full/0 "Link to this function")

full()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/document_diagnostic_report_kind.ex#L18 "View Source")

```

@spec full() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

A diagnostic report with a full

set of problems.

[Link to this function](#unchanged/0 "Link to this function")

unchanged()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/document_diagnostic_report_kind.ex#L25 "View Source")

```

@spec unchanged() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

A report indicating that the last

returned report is still accurate.





GenLSP.Enumerations.DocumentHighlightKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/document_highlight_kind.ex#L2 "View Source")

GenLSP.Enumerations.DocumentHighlightKind

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================

A document highlight kind.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[read()](#read/0)

Read-access of a symbol, like reading a variable.

[text()](#text/0)

A textual occurrence.

[write()](#write/0)

Write-access of a symbol, like writing to a variable.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/document_highlight_kind.ex#L7 "View Source")

```

@type t() :: 1 | 2 | 3

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#read/0 "Link to this function")

read()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/document_highlight_kind.ex#L21 "View Source")

```

@spec read() :: 2

```

Read-access of a symbol, like reading a variable.

[Link to this function](#text/0 "Link to this function")

text()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/document_highlight_kind.ex#L15 "View Source")

```

@spec text() :: 1

```

A textual occurrence.

[Link to this function](#write/0 "Link to this function")

write()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/document_highlight_kind.ex#L27 "View Source")

```

@spec write() :: 3

```

Write-access of a symbol, like writing to a variable.





GenLSP.Enumerations.ErrorCodes — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/error_codes.ex#L2 "View Source")

GenLSP.Enumerations.ErrorCodes

(gen\_lsp v0.6.0)

================================================================================================================================================================================================

Predefined error codes.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[internal\_error()](#internal_error/0)

[invalid\_params()](#invalid_params/0)

[invalid\_request()](#invalid_request/0)

[method\_not\_found()](#method_not_found/0)

[parse\_error()](#parse_error/0)

[server\_not\_initialized()](#server_not_initialized/0)

Error code indicating that a server received a notification or

request before the server has received the `initialize` request.

[unknown\_error\_code()](#unknown_error_code/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/error_codes.ex#L7 "View Source")

```

@type t() :: -32700 | -32600 | -32601 | -32602 | -32603 | -32002 | -32001

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#internal_error/0 "Link to this function")

internal\_error()

=================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/error_codes.ex#L24 "View Source")

```

@spec internal_error() :: -32603

```

[Link to this function](#invalid_params/0 "Link to this function")

invalid\_params()

=================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/error_codes.ex#L21 "View Source")

```

@spec invalid_params() :: -32602

```

[Link to this function](#invalid_request/0 "Link to this function")

invalid\_request()

==================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/error_codes.ex#L15 "View Source")

```

@spec invalid_request() :: -32600

```

[Link to this function](#method_not_found/0 "Link to this function")

method\_not\_found()

====================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/error_codes.ex#L18 "View Source")

```

@spec method_not_found() :: -32601

```

[Link to this function](#parse_error/0 "Link to this function")

parse\_error()

==============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/error_codes.ex#L12 "View Source")

```

@spec parse_error() :: -32700

```

[Link to this function](#server_not_initialized/0 "Link to this function")

server\_not\_initialized()

==========================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/error_codes.ex#L31 "View Source")

```

@spec server_not_initialized() :: -32002

```

Error code indicating that a server received a notification or

request before the server has received the `initialize` request.

[Link to this function](#unknown_error_code/0 "Link to this function")

unknown\_error\_code()

======================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/error_codes.ex#L34 "View Source")

```

@spec unknown_error_code() :: -32001

```





GenLSP.Enumerations.FailureHandlingKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/failure_handling_kind.ex#L2 "View Source")

GenLSP.Enumerations.FailureHandlingKind

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[abort()](#abort/0)

Applying the workspace change is simply aborted if one of the changes provided

fails. All operations executed before the failing operation stay executed.

[text\_only\_transactional()](#text_only_transactional/0)

If the workspace edit contains only textual file changes they are executed transactional.

If resource changes (create, rename or delete file) are part of the change the failure

handling strategy is abort.

[transactional()](#transactional/0)

All operations are executed transactional. That means they either all

succeed or no changes at all are applied to the workspace.

[undo()](#undo/0)

The client tries to undo the operations already executed. But there is no

guarantee that this is succeeding.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/failure_handling_kind.ex#L3 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#abort/0 "Link to this function")

abort()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/failure_handling_kind.ex#L12 "View Source")

```

@spec abort() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Applying the workspace change is simply aborted if one of the changes provided

fails. All operations executed before the failing operation stay executed.

[Link to this function](#text_only_transactional/0 "Link to this function")

text\_only\_transactional()

===========================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/failure_handling_kind.ex#L27 "View Source")

```

@spec text_only_transactional() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

If the workspace edit contains only textual file changes they are executed transactional.

If resource changes (create, rename or delete file) are part of the change the failure

handling strategy is abort.

[Link to this function](#transactional/0 "Link to this function")

transactional()

===============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/failure_handling_kind.ex#L19 "View Source")

```

@spec transactional() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

All operations are executed transactional. That means they either all

succeed or no changes at all are applied to the workspace.

[Link to this function](#undo/0 "Link to this function")

undo()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/failure_handling_kind.ex#L34 "View Source")

```

@spec undo() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

The client tries to undo the operations already executed. But there is no

guarantee that this is succeeding.





GenLSP.Enumerations.FileChangeType — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/file_change_type.ex#L2 "View Source")

GenLSP.Enumerations.FileChangeType

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

The file event type

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[changed()](#changed/0)

The file got changed.

[created()](#created/0)

The file got created.

[deleted()](#deleted/0)

The file got deleted.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/file_change_type.ex#L7 "View Source")

```

@type t() :: 1 | 2 | 3

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#changed/0 "Link to this function")

changed()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/file_change_type.ex#L21 "View Source")

```

@spec changed() :: 2

```

The file got changed.

[Link to this function](#created/0 "Link to this function")

created()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/file_change_type.ex#L15 "View Source")

```

@spec created() :: 1

```

The file got created.

[Link to this function](#deleted/0 "Link to this function")

deleted()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/file_change_type.ex#L27 "View Source")

```

@spec deleted() :: 3

```

The file got deleted.





GenLSP.Enumerations.FileOperationPatternKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/file_operation_pattern_kind.ex#L2 "View Source")

GenLSP.Enumerations.FileOperationPatternKind

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

A pattern kind describing if a glob pattern matches a file a folder or

both.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[file()](#file/0)

The pattern matches a file only.

[folder()](#folder/0)

The pattern matches a folder only.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/file_operation_pattern_kind.ex#L10 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#file/0 "Link to this function")

file()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/file_operation_pattern_kind.ex#L18 "View Source")

```

@spec file() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

The pattern matches a file only.

[Link to this function](#folder/0 "Link to this function")

folder()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/file_operation_pattern_kind.ex#L24 "View Source")

```

@spec folder() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

The pattern matches a folder only.





GenLSP.Enumerations.FoldingRangeKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/folding_range_kind.ex#L2 "View Source")

GenLSP.Enumerations.FoldingRangeKind

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================

A set of predefined range kinds.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[comment()](#comment/0)

Folding range for a comment

[imports()](#imports/0)

Folding range for an import or include

[region()](#region/0)

Folding range for a region (e.g. `#region`)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/folding_range_kind.ex#L7 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#comment/0 "Link to this function")

comment()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/folding_range_kind.ex#L15 "View Source")

```

@spec comment() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Folding range for a comment

[Link to this function](#imports/0 "Link to this function")

imports()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/folding_range_kind.ex#L21 "View Source")

```

@spec imports() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Folding range for an import or include

[Link to this function](#region/0 "Link to this function")

region()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/folding_range_kind.ex#L27 "View Source")

```

@spec region() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Folding range for a region (e.g. `#region`)





GenLSP.Enumerations.InlayHintKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/inlay_hint_kind.ex#L2 "View Source")

GenLSP.Enumerations.InlayHintKind

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================

Inlay hint kinds.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[parameter()](#parameter/0)

An inlay hint that is for a parameter.

[type()](#type/0)

An inlay hint that for a type annotation.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/inlay_hint_kind.ex#L9 "View Source")

```

@type t() :: 1 | 2

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#parameter/0 "Link to this function")

parameter()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/inlay_hint_kind.ex#L23 "View Source")

```

@spec parameter() :: 2

```

An inlay hint that is for a parameter.

[Link to this function](#type/0 "Link to this function")

type()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/inlay_hint_kind.ex#L17 "View Source")

```

@spec type() :: 1

```

An inlay hint that for a type annotation.





GenLSP.Enumerations.InsertTextFormat — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/insert_text_format.ex#L2 "View Source")

GenLSP.Enumerations.InsertTextFormat

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================

Defines whether the insert text in a completion item should be interpreted as

plain text or a snippet.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[plain\_text()](#plain_text/0)

The primary text to be inserted is treated as a plain string.

[snippet()](#snippet/0)

The primary text to be inserted is treated as a snippet.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/insert_text_format.ex#L8 "View Source")

```

@type t() :: 1 | 2

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#plain_text/0 "Link to this function")

plain\_text()

=============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/insert_text_format.ex#L16 "View Source")

```

@spec plain_text() :: 1

```

The primary text to be inserted is treated as a plain string.

[Link to this function](#snippet/0 "Link to this function")

snippet()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/insert_text_format.ex#L29 "View Source")

```

@spec snippet() :: 2

```

The primary text to be inserted is treated as a snippet.

A snippet can define tab stops and placeholders with `$1`, `$2`

and `${3:foo}`. `$0` defines the final tab stop, it defaults to

the end of the snippet. Placeholders with equal identifiers are linked,

that is typing in one will update others too.

See also: <https://microsoft.github.io/language-server-protocol/specifications/specification-current/#snippet_syntax>





GenLSP.Enumerations.InsertTextMode — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/insert_text_mode.ex#L2 "View Source")

GenLSP.Enumerations.InsertTextMode

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

How whitespace and indentation is handled during completion

item insertion.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[adjust\_indentation()](#adjust_indentation/0)

The editor adjusts leading whitespace of new lines so that

they match the indentation up to the cursor of the line for

which the item is accepted.

[as\_is()](#as_is/0)

The insertion or replace strings is taken as it is. If the

value is multi line the lines below the cursor will be

inserted using the indentation defined in the string value.

The client will not apply any kind of adjustments to the

string.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/insert_text_mode.ex#L10 "View Source")

```

@type t() :: 1 | 2

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#adjust_indentation/0 "Link to this function")

adjust\_indentation()

=====================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/insert_text_mode.ex#L34 "View Source")

```

@spec adjust_indentation() :: 2

```

The editor adjusts leading whitespace of new lines so that

they match the indentation up to the cursor of the line for

which the item is accepted.

Consider a line like this: <2tabs><cursor><3tabs>foo. Accepting a

multi line completion item is indented using 2 tabs and all

following lines inserted will be indented using 2 tabs as well.

[Link to this function](#as_is/0 "Link to this function")

as\_is()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/insert_text_mode.ex#L22 "View Source")

```

@spec as_is() :: 1

```

The insertion or replace strings is taken as it is. If the

value is multi line the lines below the cursor will be

inserted using the indentation defined in the string value.

The client will not apply any kind of adjustments to the

string.





GenLSP.Enumerations.LSPErrorCodes — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/lsp_error_codes.ex#L2 "View Source")

GenLSP.Enumerations.LSPErrorCodes

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[content\_modified()](#content_modified/0)

The server detected that the content of a document got

modified outside normal conditions. A server should

NOT send this error code if it detects a content change

in it unprocessed messages. The result even computed

on an older state might still be useful for the client.

[request\_cancelled()](#request_cancelled/0)

The client has canceled a request and a server as detected

the cancel.

[request\_failed()](#request_failed/0)

A request failed but it was syntactically correct, e.g the

method name was known and the parameters were valid. The error

message should contain human readable information about why

the request failed.

[server\_cancelled()](#server_cancelled/0)

The server cancelled the request. This error code should

only be used for requests that explicitly support being

server cancellable.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/lsp_error_codes.ex#L3 "View Source")

```

@type t() :: -32803 | -32802 | -32801 | -32800

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#content_modified/0 "Link to this function")

content\_modified()

===================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/lsp_error_codes.ex#L39 "View Source")

```

@spec content_modified() :: -32801

```

The server detected that the content of a document got

modified outside normal conditions. A server should

NOT send this error code if it detects a content change

in it unprocessed messages. The result even computed

on an older state might still be useful for the client.

If a client decides that a result is not of any use anymore

the client should cancel the request.

[Link to this function](#request_cancelled/0 "Link to this function")

request\_cancelled()

====================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/lsp_error_codes.ex#L46 "View Source")

```

@spec request_cancelled() :: -32800

```

The client has canceled a request and a server as detected

the cancel.

[Link to this function](#request_failed/0 "Link to this function")

request\_failed()

=================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/lsp_error_codes.ex#L16 "View Source")

```

@spec request_failed() :: -32803

```

A request failed but it was syntactically correct, e.g the

method name was known and the parameters were valid. The error

message should contain human readable information about why

the request failed.

@since 3.17.0

[Link to this function](#server_cancelled/0 "Link to this function")

server\_cancelled()

===================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/lsp_error_codes.ex#L26 "View Source")

```

@spec server_cancelled() :: -32802

```

The server cancelled the request. This error code should

only be used for requests that explicitly support being

server cancellable.

@since 3.17.0





GenLSP.Enumerations.MarkupKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/markup_kind.ex#L2 "View Source")

GenLSP.Enumerations.MarkupKind

(gen\_lsp v0.6.0)

================================================================================================================================================================================================

Describes the content type that a client supports in various

result literals like `Hover`, `ParameterInfo` or `CompletionItem`.

Please note that `MarkupKinds` must not start with a `$`. This kinds

are reserved for internal usage.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[markdown()](#markdown/0)

Markdown is supported as a content format

[plain\_text()](#plain_text/0)

Plain text is supported as a content format

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/markup_kind.ex#L11 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#markdown/0 "Link to this function")

markdown()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/markup_kind.ex#L25 "View Source")

```

@spec markdown() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Markdown is supported as a content format

[Link to this function](#plain_text/0 "Link to this function")

plain\_text()

=============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/markup_kind.ex#L19 "View Source")

```

@spec plain_text() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Plain text is supported as a content format





GenLSP.Enumerations.MessageType — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/message_type.ex#L2 "View Source")

GenLSP.Enumerations.MessageType

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================

The message type

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[error()](#error/0)

An error message.

[info()](#info/0)

An information message.

[log()](#log/0)

A log message.

[warning()](#warning/0)

A warning message.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/message_type.ex#L7 "View Source")

```

@type t() :: 1 | 2 | 3 | 4

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#error/0 "Link to this function")

error()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/message_type.ex#L15 "View Source")

```

@spec error() :: 1

```

An error message.

[Link to this function](#info/0 "Link to this function")

info()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/message_type.ex#L27 "View Source")

```

@spec info() :: 3

```

An information message.

[Link to this function](#log/0 "Link to this function")

log()

=====

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/message_type.ex#L33 "View Source")

```

@spec log() :: 4

```

A log message.

[Link to this function](#warning/0 "Link to this function")

warning()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/message_type.ex#L21 "View Source")

```

@spec warning() :: 2

```

A warning message.





GenLSP.Enumerations.MonikerKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/moniker_kind.ex#L2 "View Source")

GenLSP.Enumerations.MonikerKind

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================

The moniker kind.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[export()](#export/0)

The moniker represents a symbol that is exported from a project

[import()](#import/0)

The moniker represent a symbol that is imported into a project

[local()](#local/0)

The moniker represents a symbol that is local to a project (e.g. a local

variable of a function, a class not visible outside the project, ...)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/moniker_kind.ex#L9 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#export/0 "Link to this function")

export()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/moniker_kind.ex#L23 "View Source")

```

@spec export() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

The moniker represents a symbol that is exported from a project

[Link to this function](#import/0 "Link to this function")

import()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/moniker_kind.ex#L17 "View Source")

```

@spec import() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

The moniker represent a symbol that is imported into a project

[Link to this function](#local/0 "Link to this function")

local()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/moniker_kind.ex#L30 "View Source")

```

@spec local() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

The moniker represents a symbol that is local to a project (e.g. a local

variable of a function, a class not visible outside the project, ...)





GenLSP.Enumerations.NotebookCellKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/notebook_cell_kind.ex#L2 "View Source")

GenLSP.Enumerations.NotebookCellKind

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================

A notebook cell kind.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[code()](#code/0)

A code-cell is source code.

[markup()](#markup/0)

A markup-cell is formatted source that is used for display.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/notebook_cell_kind.ex#L9 "View Source")

```

@type t() :: 1 | 2

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#code/0 "Link to this function")

code()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/notebook_cell_kind.ex#L23 "View Source")

```

@spec code() :: 2

```

A code-cell is source code.

[Link to this function](#markup/0 "Link to this function")

markup()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/notebook_cell_kind.ex#L17 "View Source")

```

@spec markup() :: 1

```

A markup-cell is formatted source that is used for display.





GenLSP.Enumerations.PositionEncodingKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/position_encoding_kind.ex#L2 "View Source")

GenLSP.Enumerations.PositionEncodingKind

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================

A set of predefined position encoding kinds.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[utf8()](#utf8/0)

Character offsets count UTF-8 code units.

[utf16()](#utf16/0)

Character offsets count UTF-16 code units.

[utf32()](#utf32/0)

Character offsets count UTF-32 code units.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/position_encoding_kind.ex#L9 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#utf8/0 "Link to this function")

utf8()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/position_encoding_kind.ex#L17 "View Source")

```

@spec utf8() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Character offsets count UTF-8 code units.

[Link to this function](#utf16/0 "Link to this function")

utf16()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/position_encoding_kind.ex#L26 "View Source")

```

@spec utf16() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Character offsets count UTF-16 code units.

This is the default and must always be supported

by servers

[Link to this function](#utf32/0 "Link to this function")

utf32()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/position_encoding_kind.ex#L36 "View Source")

```

@spec utf32() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Character offsets count UTF-32 code units.

Implementation note: these are the same as Unicode code points,

so this `PositionEncodingKind` may also be used for an

encoding-agnostic representation of character offsets.





GenLSP.Enumerations.PrepareSupportDefaultBehavior — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/prepare_support_default_behavior.ex#L2 "View Source")

GenLSP.Enumerations.PrepareSupportDefaultBehavior

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[identifier()](#identifier/0)

The client's default behavior is to select the identifier

according the to language's syntax rule.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/prepare_support_default_behavior.ex#L3 "View Source")

```

@type t() :: 1

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#identifier/0 "Link to this function")

identifier()

============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/prepare_support_default_behavior.ex#L12 "View Source")

```

@spec identifier() :: 1

```

The client's default behavior is to select the identifier

according the to language's syntax rule.





GenLSP.Enumerations.ResourceOperationKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/resource_operation_kind.ex#L2 "View Source")

GenLSP.Enumerations.ResourceOperationKind

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[create()](#create/0)

Supports creating new files and folders.

[delete()](#delete/0)

Supports deleting existing files and folders.

[rename()](#rename/0)

Supports renaming existing files and folders.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/resource_operation_kind.ex#L3 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#create/0 "Link to this function")

create()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/resource_operation_kind.ex#L11 "View Source")

```

@spec create() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Supports creating new files and folders.

[Link to this function](#delete/0 "Link to this function")

delete()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/resource_operation_kind.ex#L23 "View Source")

```

@spec delete() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Supports deleting existing files and folders.

[Link to this function](#rename/0 "Link to this function")

rename()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/resource_operation_kind.ex#L17 "View Source")

```

@spec rename() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Supports renaming existing files and folders.





GenLSP.Enumerations.SemanticTokenModifiers — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L2 "View Source")

GenLSP.Enumerations.SemanticTokenModifiers

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================

A set of predefined token modifiers. This set is not fixed

an clients can specify additional token types via the

corresponding client capabilities.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[abstract()](#abstract/0)

[async()](#async/0)

[declaration()](#declaration/0)

[default\_library()](#default_library/0)

[definition()](#definition/0)

[deprecated()](#deprecated/0)

[documentation()](#documentation/0)

[modification()](#modification/0)

[readonly()](#readonly/0)

[static()](#static/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L11 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#abstract/0 "Link to this function")

abstract()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L31 "View Source")

```

@spec abstract() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#async/0 "Link to this function")

async()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L34 "View Source")

```

@spec async() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#declaration/0 "Link to this function")

declaration()

=============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L16 "View Source")

```

@spec declaration() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#default_library/0 "Link to this function")

default\_library()

==================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L43 "View Source")

```

@spec default_library() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#definition/0 "Link to this function")

definition()

============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L19 "View Source")

```

@spec definition() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#deprecated/0 "Link to this function")

deprecated()

============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L28 "View Source")

```

@spec deprecated() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#documentation/0 "Link to this function")

documentation()

===============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L40 "View Source")

```

@spec documentation() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#modification/0 "Link to this function")

modification()

==============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L37 "View Source")

```

@spec modification() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#readonly/0 "Link to this function")

readonly()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L22 "View Source")

```

@spec readonly() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#static/0 "Link to this function")

static()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_modifiers.ex#L25 "View Source")

```

@spec static() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```





GenLSP.Enumerations.SemanticTokenTypes — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L2 "View Source")

GenLSP.Enumerations.SemanticTokenTypes

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

A set of predefined token types. This set is not fixed

an clients can specify additional token types via the

corresponding client capabilities.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[class()](#class/0)

[comment()](#comment/0)

[decorator()](#decorator/0)

@since 3.17.0

[enum()](#enum/0)

[enum\_member()](#enum_member/0)

[event()](#event/0)

[function()](#function/0)

[interface()](#interface/0)

[keyword()](#keyword/0)

[macro()](#macro/0)

[method()](#method/0)

[modifier()](#modifier/0)

[namespace()](#namespace/0)

[number()](#number/0)

[operator()](#operator/0)

[parameter()](#parameter/0)

[property()](#property/0)

[regexp()](#regexp/0)

[string()](#string/0)

[struct()](#struct/0)

[type()](#type/0)

Represents a generic type. Acts as a fallback for types which can't be mapped to

a specific type like class or enum.

[type\_parameter()](#type_parameter/0)

[variable()](#variable/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L11 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#class/0 "Link to this function")

class()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L26 "View Source")

```

@spec class() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#comment/0 "Link to this function")

comment()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L71 "View Source")

```

@spec comment() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#decorator/0 "Link to this function")

decorator()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L89 "View Source")

```

@spec decorator() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

@since 3.17.0

[Link to this function](#enum/0 "Link to this function")

enum()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L29 "View Source")

```

@spec enum() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#enum_member/0 "Link to this function")

enum\_member()

==============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L50 "View Source")

```

@spec enum_member() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#event/0 "Link to this function")

event()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L53 "View Source")

```

@spec event() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#function/0 "Link to this function")

function()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L56 "View Source")

```

@spec function() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#interface/0 "Link to this function")

interface()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L32 "View Source")

```

@spec interface() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#keyword/0 "Link to this function")

keyword()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L65 "View Source")

```

@spec keyword() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#macro/0 "Link to this function")

macro()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L62 "View Source")

```

@spec macro() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#method/0 "Link to this function")

method()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L59 "View Source")

```

@spec method() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#modifier/0 "Link to this function")

modifier()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L68 "View Source")

```

@spec modifier() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#namespace/0 "Link to this function")

namespace()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L16 "View Source")

```

@spec namespace() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#number/0 "Link to this function")

number()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L77 "View Source")

```

@spec number() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#operator/0 "Link to this function")

operator()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L83 "View Source")

```

@spec operator() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#parameter/0 "Link to this function")

parameter()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L41 "View Source")

```

@spec parameter() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#property/0 "Link to this function")

property()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L47 "View Source")

```

@spec property() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#regexp/0 "Link to this function")

regexp()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L80 "View Source")

```

@spec regexp() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#string/0 "Link to this function")

string()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L74 "View Source")

```

@spec string() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#struct/0 "Link to this function")

struct()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L35 "View Source")

```

@spec struct() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#type/0 "Link to this function")

type()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L23 "View Source")

```

@spec type() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Represents a generic type. Acts as a fallback for types which can't be mapped to

a specific type like class or enum.

[Link to this function](#type_parameter/0 "Link to this function")

type\_parameter()

=================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L38 "View Source")

```

@spec type_parameter() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this function](#variable/0 "Link to this function")

variable()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/semantic_token_types.ex#L44 "View Source")

```

@spec variable() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```





GenLSP.Enumerations.SignatureHelpTriggerKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/signature_help_trigger_kind.ex#L2 "View Source")

GenLSP.Enumerations.SignatureHelpTriggerKind

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

How a signature help was triggered.

@since 3.15.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[content\_change()](#content_change/0)

Signature help was triggered by the cursor moving or by the document content changing.

[invoked()](#invoked/0)

Signature help was invoked manually by the user or by a command.

[trigger\_character()](#trigger_character/0)

Signature help was triggered by a trigger character.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/signature_help_trigger_kind.ex#L9 "View Source")

```

@type t() :: 1 | 2 | 3

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#content_change/0 "Link to this function")

content\_change()

=================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/signature_help_trigger_kind.ex#L29 "View Source")

```

@spec content_change() :: 3

```

Signature help was triggered by the cursor moving or by the document content changing.

[Link to this function](#invoked/0 "Link to this function")

invoked()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/signature_help_trigger_kind.ex#L17 "View Source")

```

@spec invoked() :: 1

```

Signature help was invoked manually by the user or by a command.

[Link to this function](#trigger_character/0 "Link to this function")

trigger\_character()

====================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/signature_help_trigger_kind.ex#L23 "View Source")

```

@spec trigger_character() :: 2

```

Signature help was triggered by a trigger character.





GenLSP.Enumerations.SymbolKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L2 "View Source")

GenLSP.Enumerations.SymbolKind

(gen\_lsp v0.6.0)

================================================================================================================================================================================================

A symbol kind.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[array()](#array/0)

[boolean()](#boolean/0)

[class()](#class/0)

[constant()](#constant/0)

[constructor()](#constructor/0)

[enum()](#enum/0)

[enum\_member()](#enum_member/0)

[event()](#event/0)

[field()](#field/0)

[file()](#file/0)

[function()](#function/0)

[interface()](#interface/0)

[key()](#key/0)

[method()](#method/0)

[module()](#module/0)

[namespace()](#namespace/0)

[null()](#null/0)

[number()](#number/0)

[object()](#object/0)

[operator()](#operator/0)

[package()](#package/0)

[property()](#property/0)

[string()](#string/0)

[struct()](#struct/0)

[type\_parameter()](#type_parameter/0)

[variable()](#variable/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L7 "View Source")

```

@type t() ::

  1

  | 2

  | 3

  | 4

  | 5

  | 6

  | 7

  | 8

  | 9

  | 10

  | 11

  | 12

  | 13

  | 14

  | 15

  | 16

  | 17

  | 18

  | 19

  | 20

  | 21

  | 22

  | 23

  | 24

  | 25

  | 26

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#array/0 "Link to this function")

array()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L89 "View Source")

```

@spec array() :: 18

```

[Link to this function](#boolean/0 "Link to this function")

boolean()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L86 "View Source")

```

@spec boolean() :: 17

```

[Link to this function](#class/0 "Link to this function")

class()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L50 "View Source")

```

@spec class() :: 5

```

[Link to this function](#constant/0 "Link to this function")

constant()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L77 "View Source")

```

@spec constant() :: 14

```

[Link to this function](#constructor/0 "Link to this function")

constructor()

=============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L62 "View Source")

```

@spec constructor() :: 9

```

[Link to this function](#enum/0 "Link to this function")

enum()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L65 "View Source")

```

@spec enum() :: 10

```

[Link to this function](#enum_member/0 "Link to this function")

enum\_member()

==============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L101 "View Source")

```

@spec enum_member() :: 22

```

[Link to this function](#event/0 "Link to this function")

event()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L107 "View Source")

```

@spec event() :: 24

```

[Link to this function](#field/0 "Link to this function")

field()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L59 "View Source")

```

@spec field() :: 8

```

[Link to this function](#file/0 "Link to this function")

file()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L38 "View Source")

```

@spec file() :: 1

```

[Link to this function](#function/0 "Link to this function")

function()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L71 "View Source")

```

@spec function() :: 12

```

[Link to this function](#interface/0 "Link to this function")

interface()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L68 "View Source")

```

@spec interface() :: 11

```

[Link to this function](#key/0 "Link to this function")

key()

=====

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L95 "View Source")

```

@spec key() :: 20

```

[Link to this function](#method/0 "Link to this function")

method()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L53 "View Source")

```

@spec method() :: 6

```

[Link to this function](#module/0 "Link to this function")

module()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L41 "View Source")

```

@spec module() :: 2

```

[Link to this function](#namespace/0 "Link to this function")

namespace()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L44 "View Source")

```

@spec namespace() :: 3

```

[Link to this function](#null/0 "Link to this function")

null()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L98 "View Source")

```

@spec null() :: 21

```

[Link to this function](#number/0 "Link to this function")

number()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L83 "View Source")

```

@spec number() :: 16

```

[Link to this function](#object/0 "Link to this function")

object()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L92 "View Source")

```

@spec object() :: 19

```

[Link to this function](#operator/0 "Link to this function")

operator()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L110 "View Source")

```

@spec operator() :: 25

```

[Link to this function](#package/0 "Link to this function")

package()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L47 "View Source")

```

@spec package() :: 4

```

[Link to this function](#property/0 "Link to this function")

property()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L56 "View Source")

```

@spec property() :: 7

```

[Link to this function](#string/0 "Link to this function")

string()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L80 "View Source")

```

@spec string() :: 15

```

[Link to this function](#struct/0 "Link to this function")

struct()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L104 "View Source")

```

@spec struct() :: 23

```

[Link to this function](#type_parameter/0 "Link to this function")

type\_parameter()

=================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L113 "View Source")

```

@spec type_parameter() :: 26

```

[Link to this function](#variable/0 "Link to this function")

variable()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_kind.ex#L74 "View Source")

```

@spec variable() :: 13

```





GenLSP.Enumerations.SymbolTag — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_tag.ex#L2 "View Source")

GenLSP.Enumerations.SymbolTag

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================

Symbol tags are extra annotations that tweak the rendering of a symbol.

@since 3.16

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[deprecated()](#deprecated/0)

Render a symbol as obsolete, usually using a strike-out.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_tag.ex#L9 "View Source")

```

@type t() :: 1

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#deprecated/0 "Link to this function")

deprecated()

============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/symbol_tag.ex#L17 "View Source")

```

@spec deprecated() :: 1

```

Render a symbol as obsolete, usually using a strike-out.





GenLSP.Enumerations.TextDocumentSaveReason — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/text_document_save_reason.ex#L2 "View Source")

GenLSP.Enumerations.TextDocumentSaveReason

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

Represents reasons why a text document is saved.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[after\_delay()](#after_delay/0)

Automatic after a delay.

[focus\_out()](#focus_out/0)

When the editor lost focus.

[manual()](#manual/0)

Manually triggered, e.g. by the user pressing save, by starting debugging,

or by an API call.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/text_document_save_reason.ex#L7 "View Source")

```

@type t() :: 1 | 2 | 3

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#after_delay/0 "Link to this function")

after\_delay()

==============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/text_document_save_reason.ex#L22 "View Source")

```

@spec after_delay() :: 2

```

Automatic after a delay.

[Link to this function](#focus_out/0 "Link to this function")

focus\_out()

============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/text_document_save_reason.ex#L28 "View Source")

```

@spec focus_out() :: 3

```

When the editor lost focus.

[Link to this function](#manual/0 "Link to this function")

manual()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/text_document_save_reason.ex#L16 "View Source")

```

@spec manual() :: 1

```

Manually triggered, e.g. by the user pressing save, by starting debugging,

or by an API call.





GenLSP.Enumerations.TextDocumentSyncKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/text_document_sync_kind.ex#L2 "View Source")

GenLSP.Enumerations.TextDocumentSyncKind

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

Defines how the host (editor) should sync

document changes to the language server.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[full()](#full/0)

Documents are synced by always sending the full content

of the document.

[incremental()](#incremental/0)

Documents are synced by sending the full content on open.

After that only incremental updates to the document are

send.

[none()](#none/0)

Documents should not be synced at all.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/text_document_sync_kind.ex#L8 "View Source")

```

@type t() :: 0 | 1 | 2

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#full/0 "Link to this function")

full()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/text_document_sync_kind.ex#L23 "View Source")

```

@spec full() :: 1

```

Documents are synced by always sending the full content

of the document.

[Link to this function](#incremental/0 "Link to this function")

incremental()

=============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/text_document_sync_kind.ex#L31 "View Source")

```

@spec incremental() :: 2

```

Documents are synced by sending the full content on open.

After that only incremental updates to the document are

send.

[Link to this function](#none/0 "Link to this function")

none()

======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/text_document_sync_kind.ex#L16 "View Source")

```

@spec none() :: 0

```

Documents should not be synced at all.





GenLSP.Enumerations.TokenFormat — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/token_format.ex#L2 "View Source")

GenLSP.Enumerations.TokenFormat

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[relative()](#relative/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/token_format.ex#L3 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#relative/0 "Link to this function")

relative()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/token_format.ex#L8 "View Source")

```

@spec relative() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```





GenLSP.Enumerations.TraceValues — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/trace_values.ex#L2 "View Source")

GenLSP.Enumerations.TraceValues

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[messages()](#messages/0)

Trace messages only.

[off()](#off/0)

Turn tracing off.

[verbose()](#verbose/0)

Verbose message tracing.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/trace_values.ex#L3 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#messages/0 "Link to this function")

messages()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/trace_values.ex#L17 "View Source")

```

@spec messages() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Trace messages only.

[Link to this function](#off/0 "Link to this function")

off()

=====

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/trace_values.ex#L11 "View Source")

```

@spec off() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Turn tracing off.

[Link to this function](#verbose/0 "Link to this function")

verbose()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/trace_values.ex#L23 "View Source")

```

@spec verbose() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

Verbose message tracing.





GenLSP.Enumerations.UniquenessLevel — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/uniqueness_level.ex#L2 "View Source")

GenLSP.Enumerations.UniquenessLevel

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

Moniker uniqueness level to define scope of the moniker.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[document()](#document/0)

The moniker is only unique inside a document

[global()](#global/0)

The moniker is globally unique

[group()](#group/0)

The moniker is unique inside the group to which a project belongs

[project()](#project/0)

The moniker is unique inside a project for which a dump got created

[scheme()](#scheme/0)

The moniker is unique inside the moniker scheme.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/uniqueness_level.ex#L9 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#document/0 "Link to this function")

document()

==========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/uniqueness_level.ex#L17 "View Source")

```

@spec document() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

The moniker is only unique inside a document

[Link to this function](#global/0 "Link to this function")

global()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/uniqueness_level.ex#L41 "View Source")

```

@spec global() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

The moniker is globally unique

[Link to this function](#group/0 "Link to this function")

group()

=======

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/uniqueness_level.ex#L29 "View Source")

```

@spec group() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

The moniker is unique inside the group to which a project belongs

[Link to this function](#project/0 "Link to this function")

project()

=========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/uniqueness_level.ex#L23 "View Source")

```

@spec project() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

The moniker is unique inside a project for which a dump got created

[Link to this function](#scheme/0 "Link to this function")

scheme()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/uniqueness_level.ex#L35 "View Source")

```

@spec scheme() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```

The moniker is unique inside the moniker scheme.





GenLSP.Enumerations.WatchKind — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/watch_kind.ex#L2 "View Source")

GenLSP.Enumerations.WatchKind

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[change()](#change/0)

Interested in change events

[create()](#create/0)

Interested in create events.

[delete()](#delete/0)

Interested in delete events

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/watch_kind.ex#L3 "View Source")

```

@type t() :: 1 | 2 | 4

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#change/0 "Link to this function")

change()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/watch_kind.ex#L17 "View Source")

```

@spec change() :: 2

```

Interested in change events

[Link to this function](#create/0 "Link to this function")

create()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/watch_kind.ex#L11 "View Source")

```

@spec create() :: 1

```

Interested in create events.

[Link to this function](#delete/0 "Link to this function")

delete()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/enumerations/watch_kind.ex#L23 "View Source")

```

@spec delete() :: 4

```

Interested in delete events





GenLSP.ErrorResponse — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/error_response.ex#L2 "View Source")

GenLSP.ErrorResponse

(gen\_lsp v0.6.0)

============================================================================================================================================================================

A Response Message sent as a result of a request.

If a request doesn’t provide a result value the receiver of a request still needs to return a response message to conform to the JSON-RPC specification.

The result property of the ResponseMessage should be set to null in this case to signal a successful request.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[schematic()](#schematic/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/error_response.ex#L14 "View Source")

```

@type t() :: %GenLSP.ErrorResponse{

  code: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  data: ([String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | [number](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [list](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil) | nil,

  message: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#schematic/0 "Link to this function")

schematic()

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/error_response.ex#L21 "View Source")

```

@spec schematic() :: [Schematic.t](https://hexdocs.pm/schematic/0.2.1/Schematic.html#t:t/0)()

```





GenLSP.LSP — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/lsp.ex#L1 "View Source")

GenLSP.LSP

(gen\_lsp v0.6.0)

==============================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.LSP{}](#__struct__/0)

The LSP data structure.

[assign(lsp, new\_assigns)](#assign/2)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/lsp.ex#L7 "View Source")

```

@type t() :: %GenLSP.LSP{

  assigns: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  buffer: ([atom](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [pid](https://hexdocs.pm/elixir/typespecs.html#basic-types)()) | nil,

  mod: [atom](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  pid: [pid](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.LSP{}

=============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/lsp.ex#L7 "View Source")

(struct)

The LSP data structure.

[Link to this function](#assign/2 "Link to this function")

assign(lsp, new\_assigns)

=========================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/lsp.ex#L15 "View Source")

```

@spec assign([t](#t:t/0)(), [Keyword.t](https://hexdocs.pm/elixir/Keyword.html#t:t/0)()) :: [t](#t:t/0)()

```





GenLSP.Notifications — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications.ex#L2 "View Source")

GenLSP.Notifications

(gen\_lsp v0.6.0)

===========================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Functions](#functions)

------------------------

[new(notification)](#new/1)

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#new/1 "Link to this function")

new(notification)

=================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications.ex#L5 "View Source")





GenLSP.Notifications.DollarCancelRequest — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/dollar_cancel_request.ex#L2 "View Source")

GenLSP.Notifications.DollarCancelRequest

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/dollar_cancel_request.ex#L8 "View Source")

```

@type t() :: %GenLSP.Notifications.DollarCancelRequest{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CancelParams.t](GenLSP.Structures.CancelParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.DollarLogTrace — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/dollar_log_trace.ex#L2 "View Source")

GenLSP.Notifications.DollarLogTrace

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/dollar_log_trace.ex#L8 "View Source")

```

@type t() :: %GenLSP.Notifications.DollarLogTrace{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.LogTraceParams.t](GenLSP.Structures.LogTraceParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.DollarProgress — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/dollar_progress.ex#L2 "View Source")

GenLSP.Notifications.DollarProgress

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/dollar_progress.ex#L8 "View Source")

```

@type t() :: %GenLSP.Notifications.DollarProgress{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.ProgressParams.t](GenLSP.Structures.ProgressParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.DollarSetTrace — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/dollar_set_trace.ex#L2 "View Source")

GenLSP.Notifications.DollarSetTrace

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/dollar_set_trace.ex#L8 "View Source")

```

@type t() :: %GenLSP.Notifications.DollarSetTrace{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.SetTraceParams.t](GenLSP.Structures.SetTraceParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.Exit — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/exit.ex#L2 "View Source")

GenLSP.Notifications.Exit

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================

The exit event is sent from the client to the server to

ask the server to exit its process.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/exit.ex#L15 "View Source")

```

@type t() :: %GenLSP.Notifications.Exit{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: nil | nil

}

```





GenLSP.Notifications.Initialized — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/initialized.ex#L2 "View Source")

GenLSP.Notifications.Initialized

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================

The initialized notification is sent from the client to the

server after the client is fully initialized and the server

is allowed to send requests from the server to the client.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/initialized.ex#L16 "View Source")

```

@type t() :: %GenLSP.Notifications.Initialized{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.InitializedParams.t](GenLSP.Structures.InitializedParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.NotebookDocumentDidChange — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/notebook_document_did_change.ex#L2 "View Source")

GenLSP.Notifications.NotebookDocumentDidChange

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/notebook_document_did_change.ex#L8 "View Source")

```

@type t() :: %GenLSP.Notifications.NotebookDocumentDidChange{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DidChangeNotebookDocumentParams.t](GenLSP.Structures.DidChangeNotebookDocumentParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.NotebookDocumentDidClose — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/notebook_document_did_close.ex#L2 "View Source")

GenLSP.Notifications.NotebookDocumentDidClose

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================

A notification sent when a notebook closes.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/notebook_document_did_close.ex#L16 "View Source")

```

@type t() :: %GenLSP.Notifications.NotebookDocumentDidClose{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DidCloseNotebookDocumentParams.t](GenLSP.Structures.DidCloseNotebookDocumentParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.NotebookDocumentDidOpen — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/notebook_document_did_open.ex#L2 "View Source")

GenLSP.Notifications.NotebookDocumentDidOpen

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

A notification sent when a notebook opens.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/notebook_document_did_open.ex#L16 "View Source")

```

@type t() :: %GenLSP.Notifications.NotebookDocumentDidOpen{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DidOpenNotebookDocumentParams.t](GenLSP.Structures.DidOpenNotebookDocumentParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.NotebookDocumentDidSave — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/notebook_document_did_save.ex#L2 "View Source")

GenLSP.Notifications.NotebookDocumentDidSave

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

A notification sent when a notebook document is saved.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/notebook_document_did_save.ex#L16 "View Source")

```

@type t() :: %GenLSP.Notifications.NotebookDocumentDidSave{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DidSaveNotebookDocumentParams.t](GenLSP.Structures.DidSaveNotebookDocumentParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.TelemetryEvent — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/telemetry_event.ex#L2 "View Source")

GenLSP.Notifications.TelemetryEvent

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

The telemetry event notification is sent from the server to the client to ask

the client to log telemetry data.

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/telemetry_event.ex#L15 "View Source")

```

@type t() :: %GenLSP.Notifications.TelemetryEvent{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil

}

```





GenLSP.Notifications.TextDocumentDidChange — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_did_change.ex#L2 "View Source")

GenLSP.Notifications.TextDocumentDidChange

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

The document change notification is sent from the client to the server to signal

changes to a text document.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_did_change.ex#L15 "View Source")

```

@type t() :: %GenLSP.Notifications.TextDocumentDidChange{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DidChangeTextDocumentParams.t](GenLSP.Structures.DidChangeTextDocumentParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.TextDocumentDidClose — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_did_close.ex#L2 "View Source")

GenLSP.Notifications.TextDocumentDidClose

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================

The document close notification is sent from the client to the server when

the document got closed in the client. The document's truth now exists where

the document's uri points to (e.g. if the document's uri is a file uri the

truth now exists on disk). As with the open notification the close notification

is about managing the document's content. Receiving a close notification

doesn't mean that the document was open in an editor before. A close

notification requires a previous open notification to be sent.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_did_close.ex#L20 "View Source")

```

@type t() :: %GenLSP.Notifications.TextDocumentDidClose{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DidCloseTextDocumentParams.t](GenLSP.Structures.DidCloseTextDocumentParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.TextDocumentDidOpen — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_did_open.ex#L2 "View Source")

GenLSP.Notifications.TextDocumentDidOpen

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

The document open notification is sent from the client to the server to signal

newly opened text documents. The document's truth is now managed by the client

and the server must not try to read the document's truth using the document's

uri. Open in this sense means it is managed by the client. It doesn't necessarily

mean that its content is presented in an editor. An open notification must not

be sent more than once without a corresponding close notification send before.

This means open and close notification must be balanced and the max open count

is one.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_did_open.ex#L21 "View Source")

```

@type t() :: %GenLSP.Notifications.TextDocumentDidOpen{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DidOpenTextDocumentParams.t](GenLSP.Structures.DidOpenTextDocumentParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.TextDocumentDidSave — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_did_save.ex#L2 "View Source")

GenLSP.Notifications.TextDocumentDidSave

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

The document save notification is sent from the client to the server when

the document got saved in the client.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_did_save.ex#L15 "View Source")

```

@type t() :: %GenLSP.Notifications.TextDocumentDidSave{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DidSaveTextDocumentParams.t](GenLSP.Structures.DidSaveTextDocumentParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.TextDocumentPublishDiagnostics — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_publish_diagnostics.ex#L2 "View Source")

GenLSP.Notifications.TextDocumentPublishDiagnostics

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================================

Diagnostics notification are sent from the server to the client to signal

results of validation runs.

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_publish_diagnostics.ex#L15 "View Source")

```

@type t() :: %GenLSP.Notifications.TextDocumentPublishDiagnostics{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.PublishDiagnosticsParams.t](GenLSP.Structures.PublishDiagnosticsParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.TextDocumentWillSave — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_will_save.ex#L2 "View Source")

GenLSP.Notifications.TextDocumentWillSave

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================

A document will save notification is sent from the client to the server before

the document is actually saved.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/text_document_will_save.ex#L15 "View Source")

```

@type t() :: %GenLSP.Notifications.TextDocumentWillSave{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.WillSaveTextDocumentParams.t](GenLSP.Structures.WillSaveTextDocumentParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.WindowLogMessage — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/window_log_message.ex#L2 "View Source")

GenLSP.Notifications.WindowLogMessage

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

The log message notification is sent from the server to the client to ask

the client to log a particular message.

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/window_log_message.ex#L15 "View Source")

```

@type t() :: %GenLSP.Notifications.WindowLogMessage{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.LogMessageParams.t](GenLSP.Structures.LogMessageParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.WindowShowMessage — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/window_show_message.ex#L2 "View Source")

GenLSP.Notifications.WindowShowMessage

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

The show message notification is sent from a server to a client to ask

the client to display a particular message in the user interface.

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/window_show_message.ex#L15 "View Source")

```

@type t() :: %GenLSP.Notifications.WindowShowMessage{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.ShowMessageParams.t](GenLSP.Structures.ShowMessageParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.WindowWorkDoneProgressCancel — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/window_work_done_progress_cancel.ex#L2 "View Source")

GenLSP.Notifications.WindowWorkDoneProgressCancel

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================================

The `window/workDoneProgress/cancel` notification is sent from the client to the server to cancel a progress

initiated on the server side.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/window_work_done_progress_cancel.ex#L15 "View Source")

```

@type t() :: %GenLSP.Notifications.WindowWorkDoneProgressCancel{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.WorkDoneProgressCancelParams.t](GenLSP.Structures.WorkDoneProgressCancelParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.WorkspaceDidChangeConfiguration — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_change_configuration.ex#L2 "View Source")

GenLSP.Notifications.WorkspaceDidChangeConfiguration

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================================

The configuration change notification is sent from the client to the server

when the client's configuration has changed. The notification contains

the changed configuration as defined by the language client.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_change_configuration.ex#L16 "View Source")

```

@type t() :: %GenLSP.Notifications.WorkspaceDidChangeConfiguration{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DidChangeConfigurationParams.t](GenLSP.Structures.DidChangeConfigurationParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.WorkspaceDidChangeWatchedFiles — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_change_watched_files.ex#L2 "View Source")

GenLSP.Notifications.WorkspaceDidChangeWatchedFiles

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================================================

The watched files notification is sent from the client to the server when

the client detects changes to file watched by the language client.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_change_watched_files.ex#L15 "View Source")

```

@type t() :: %GenLSP.Notifications.WorkspaceDidChangeWatchedFiles{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DidChangeWatchedFilesParams.t](GenLSP.Structures.DidChangeWatchedFilesParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.WorkspaceDidChangeWorkspaceFolders — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_change_workspace_folders.ex#L2 "View Source")

GenLSP.Notifications.WorkspaceDidChangeWorkspaceFolders

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================================================

The `workspace/didChangeWorkspaceFolders` notification is sent from the client to the server when the workspace

folder configuration changes.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_change_workspace_folders.ex#L15 "View Source")

```

@type t() :: %GenLSP.Notifications.WorkspaceDidChangeWorkspaceFolders{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DidChangeWorkspaceFoldersParams.t](GenLSP.Structures.DidChangeWorkspaceFoldersParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.WorkspaceDidCreateFiles — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_create_files.ex#L2 "View Source")

GenLSP.Notifications.WorkspaceDidCreateFiles

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

The did create files notification is sent from the client to the server when

files were created from within the client.

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_create_files.ex#L17 "View Source")

```

@type t() :: %GenLSP.Notifications.WorkspaceDidCreateFiles{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CreateFilesParams.t](GenLSP.Structures.CreateFilesParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.WorkspaceDidDeleteFiles — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_delete_files.ex#L2 "View Source")

GenLSP.Notifications.WorkspaceDidDeleteFiles

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

The will delete files request is sent from the client to the server before files are actually

deleted as long as the deletion is triggered from within the client.

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_delete_files.ex#L17 "View Source")

```

@type t() :: %GenLSP.Notifications.WorkspaceDidDeleteFiles{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DeleteFilesParams.t](GenLSP.Structures.DeleteFilesParams.html#t:t/0)() | nil

}

```





GenLSP.Notifications.WorkspaceDidRenameFiles — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_rename_files.ex#L2 "View Source")

GenLSP.Notifications.WorkspaceDidRenameFiles

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

The did rename files notification is sent from the client to the server when

files were renamed from within the client.

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/notifications/workspace_did_rename_files.ex#L17 "View Source")

```

@type t() :: %GenLSP.Notifications.WorkspaceDidRenameFiles{

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.RenameFilesParams.t](GenLSP.Structures.RenameFilesParams.html#t:t/0)() | nil

}

```





GenLSP.Requests — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests.ex#L2 "View Source")

GenLSP.Requests

(gen\_lsp v0.6.0)

=================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Functions](#functions)

------------------------

[new(request)](#new/1)

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#new/1 "Link to this function")

new(request)

============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests.ex#L5 "View Source")





GenLSP.Requests.CallHierarchyIncomingCalls — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/call_hierarchy_incoming_calls.ex#L2 "View Source")

GenLSP.Requests.CallHierarchyIncomingCalls

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

A request to resolve the incoming calls for a given `CallHierarchyItem`.

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/call_hierarchy_incoming_calls.ex#L23 "View Source")

```

@type result() :: [[GenLSP.Structures.CallHierarchyIncomingCall.t](GenLSP.Structures.CallHierarchyIncomingCall.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/call_hierarchy_incoming_calls.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.CallHierarchyIncomingCalls{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CallHierarchyIncomingCallsParams.t](GenLSP.Structures.CallHierarchyIncomingCallsParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.CallHierarchyOutgoingCalls — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/call_hierarchy_outgoing_calls.ex#L2 "View Source")

GenLSP.Requests.CallHierarchyOutgoingCalls

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

A request to resolve the outgoing calls for a given `CallHierarchyItem`.

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/call_hierarchy_outgoing_calls.ex#L23 "View Source")

```

@type result() :: [[GenLSP.Structures.CallHierarchyOutgoingCall.t](GenLSP.Structures.CallHierarchyOutgoingCall.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/call_hierarchy_outgoing_calls.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.CallHierarchyOutgoingCalls{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CallHierarchyOutgoingCallsParams.t](GenLSP.Structures.CallHierarchyOutgoingCallsParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.ClientRegisterCapability — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/client_register_capability.ex#L2 "View Source")

GenLSP.Requests.ClientRegisterCapability

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================

The `client/registerCapability` request is sent from the server to the client to register a new capability

handler on the client side.

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/client_register_capability.ex#L22 "View Source")

```

@type result() :: nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/client_register_capability.ex#L15 "View Source")

```

@type t() :: %GenLSP.Requests.ClientRegisterCapability{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.RegistrationParams.t](GenLSP.Structures.RegistrationParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.ClientUnregisterCapability — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/client_unregister_capability.ex#L2 "View Source")

GenLSP.Requests.ClientUnregisterCapability

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================

The `client/unregisterCapability` request is sent from the server to the client to unregister a previously registered capability

handler on the client side.

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/client_unregister_capability.ex#L22 "View Source")

```

@type result() :: nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/client_unregister_capability.ex#L15 "View Source")

```

@type t() :: %GenLSP.Requests.ClientUnregisterCapability{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.UnregistrationParams.t](GenLSP.Structures.UnregistrationParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.CodeActionResolve — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/code_action_resolve.ex#L2 "View Source")

GenLSP.Requests.CodeActionResolve

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================

Request to resolve additional information for a given code action.The request's

parameter is of type {@link CodeAction} the response

is of type {@link CodeAction} or a Thenable that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/code_action_resolve.ex#L23 "View Source")

```

@type result() :: [GenLSP.Structures.CodeAction.t](GenLSP.Structures.CodeAction.html#t:t/0)()

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/code_action_resolve.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.CodeActionResolve{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CodeAction.t](GenLSP.Structures.CodeAction.html#t:t/0)() | nil

}

```





GenLSP.Requests.CodeLensResolve — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/code_lens_resolve.ex#L2 "View Source")

GenLSP.Requests.CodeLensResolve

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================

A request to resolve a command for a given code lens.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/code_lens_resolve.ex#L21 "View Source")

```

@type result() :: [GenLSP.Structures.CodeLens.t](GenLSP.Structures.CodeLens.html#t:t/0)()

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/code_lens_resolve.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.CodeLensResolve{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CodeLens.t](GenLSP.Structures.CodeLens.html#t:t/0)() | nil

}

```





GenLSP.Requests.CompletionItemResolve — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/completion_item_resolve.ex#L2 "View Source")

GenLSP.Requests.CompletionItemResolve

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

Request to resolve additional information for a given completion item.The request's

parameter is of type {@link CompletionItem} the response

is of type {@link CompletionItem} or a Thenable that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/completion_item_resolve.ex#L23 "View Source")

```

@type result() :: [GenLSP.Structures.CompletionItem.t](GenLSP.Structures.CompletionItem.html#t:t/0)()

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/completion_item_resolve.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.CompletionItemResolve{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CompletionItem.t](GenLSP.Structures.CompletionItem.html#t:t/0)() | nil

}

```





GenLSP.Requests.DocumentLinkResolve — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/document_link_resolve.ex#L2 "View Source")

GenLSP.Requests.DocumentLinkResolve

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

Request to resolve additional information for a given document link. The request's

parameter is of type {@link DocumentLink} the response

is of type {@link DocumentLink} or a Thenable that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/document_link_resolve.ex#L23 "View Source")

```

@type result() :: [GenLSP.Structures.DocumentLink.t](GenLSP.Structures.DocumentLink.html#t:t/0)()

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/document_link_resolve.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.DocumentLinkResolve{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DocumentLink.t](GenLSP.Structures.DocumentLink.html#t:t/0)() | nil

}

```





GenLSP.Requests.Initialize — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/initialize.ex#L2 "View Source")

GenLSP.Requests.Initialize

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================

The initialize request is sent from the client to the server.

It is sent once as the request after starting up the server.

The requests parameter is of type {@link InitializeParams}

the response if of type {@link InitializeResult} of a Thenable that

resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/initialize.ex#L25 "View Source")

```

@type result() :: [GenLSP.Structures.InitializeResult.t](GenLSP.Structures.InitializeResult.html#t:t/0)()

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/initialize.ex#L18 "View Source")

```

@type t() :: %GenLSP.Requests.Initialize{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.InitializeParams.t](GenLSP.Structures.InitializeParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.InlayHintResolve — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/inlay_hint_resolve.ex#L2 "View Source")

GenLSP.Requests.InlayHintResolve

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================

A request to resolve additional properties for an inlay hint.

The request's parameter is of type {@link InlayHint}, the response is

of type {@link InlayHint} or a Thenable that resolves to such.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/inlay_hint_resolve.ex#L25 "View Source")

```

@type result() :: [GenLSP.Structures.InlayHint.t](GenLSP.Structures.InlayHint.html#t:t/0)()

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/inlay_hint_resolve.ex#L18 "View Source")

```

@type t() :: %GenLSP.Requests.InlayHintResolve{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.InlayHint.t](GenLSP.Structures.InlayHint.html#t:t/0)() | nil

}

```





GenLSP.Requests.Shutdown — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/shutdown.ex#L2 "View Source")

GenLSP.Requests.Shutdown

(gen\_lsp v0.6.0)

===================================================================================================================================================================================

A shutdown request is sent from the client to the server.

It is sent once when the client decides to shutdown the

server. The only notification that is sent after a shutdown request

is the exit event.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/shutdown.ex#L23 "View Source")

```

@type result() :: nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/shutdown.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.Shutdown{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```





GenLSP.Requests.TextDocumentCodeAction — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_code_action.ex#L2 "View Source")

GenLSP.Requests.TextDocumentCodeAction

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================

A request to provide commands for the given text document and range.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_code_action.ex#L21 "View Source")

```

@type result() ::

  [[GenLSP.Structures.Command.t](GenLSP.Structures.Command.html#t:t/0)() | [GenLSP.Structures.CodeAction.t](GenLSP.Structures.CodeAction.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_code_action.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentCodeAction{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CodeActionParams.t](GenLSP.Structures.CodeActionParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentCodeLens — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_code_lens.ex#L2 "View Source")

GenLSP.Requests.TextDocumentCodeLens

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================

A request to provide code lens for the given text document.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_code_lens.ex#L21 "View Source")

```

@type result() :: [[GenLSP.Structures.CodeLens.t](GenLSP.Structures.CodeLens.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_code_lens.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentCodeLens{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CodeLensParams.t](GenLSP.Structures.CodeLensParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentColorPresentation — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_color_presentation.ex#L2 "View Source")

GenLSP.Requests.TextDocumentColorPresentation

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================

A request to list all presentation for a color. The request's

parameter is of type {@link ColorPresentationParams} the

response is of type {@link ColorInformation ColorInformation[]} or a Thenable

that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_color_presentation.ex#L24 "View Source")

```

@type result() :: [[GenLSP.Structures.ColorPresentation.t](GenLSP.Structures.ColorPresentation.html#t:t/0)()]

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_color_presentation.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentColorPresentation{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.ColorPresentationParams.t](GenLSP.Structures.ColorPresentationParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentCompletion — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_completion.ex#L2 "View Source")

GenLSP.Requests.TextDocumentCompletion

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

Request to request completion at a given text document position. The request's

parameter is of type {@link TextDocumentPosition} the response

is of type {@link CompletionItem CompletionItem[]} or {@link CompletionList}

or a Thenable that resolves to such.

The request can delay the computation of the {@link CompletionItem.detail `detail`}

and {@link CompletionItem.documentation `documentation`} properties to the `completionItem/resolve`

request. However, properties that are needed for the initial sorting and filtering, like `sortText`,

`filterText`, `insertText`, and `textEdit`, must not be changed during resolve.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_completion.ex#L29 "View Source")

```

@type result() ::

  [[GenLSP.Structures.CompletionItem.t](GenLSP.Structures.CompletionItem.html#t:t/0)()]

  | [GenLSP.Structures.CompletionList.t](GenLSP.Structures.CompletionList.html#t:t/0)()

  | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_completion.ex#L22 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentCompletion{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CompletionParams.t](GenLSP.Structures.CompletionParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentDeclaration — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_declaration.ex#L2 "View Source")

GenLSP.Requests.TextDocumentDeclaration

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================

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]

(#TextDocumentPositionParams) the response is of type {@link Declaration}

or a typed array of {@link DeclarationLink} or a Thenable that resolves

to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_declaration.ex#L25 "View Source")

```

@type result() ::

  [GenLSP.TypeAlias.Declaration.t](GenLSP.TypeAlias.Declaration.html#t:t/0)()

  | [[GenLSP.TypeAlias.DeclarationLink.t](GenLSP.TypeAlias.DeclarationLink.html#t:t/0)()]

  | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_declaration.ex#L18 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentDeclaration{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DeclarationParams.t](GenLSP.Structures.DeclarationParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentDefinition — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_definition.ex#L2 "View Source")

GenLSP.Requests.TextDocumentDefinition

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

A request to resolve the definition location of a symbol at a given text

document position. The request's parameter is of type [TextDocumentPosition]

(#TextDocumentPosition) the response is of either type {@link Definition}

or a typed array of {@link DefinitionLink} or a Thenable that resolves

to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_definition.ex#L25 "View Source")

```

@type result() ::

  [GenLSP.TypeAlias.Definition.t](GenLSP.TypeAlias.Definition.html#t:t/0)() | [[GenLSP.TypeAlias.DefinitionLink.t](GenLSP.TypeAlias.DefinitionLink.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_definition.ex#L18 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentDefinition{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DefinitionParams.t](GenLSP.Structures.DefinitionParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentDiagnostic — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_diagnostic.ex#L2 "View Source")

GenLSP.Requests.TextDocumentDiagnostic

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

The document diagnostic request definition.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_diagnostic.ex#L23 "View Source")

```

@type result() :: [GenLSP.TypeAlias.DocumentDiagnosticReport.t](GenLSP.TypeAlias.DocumentDiagnosticReport.html#t:t/0)()

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_diagnostic.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentDiagnostic{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DocumentDiagnosticParams.t](GenLSP.Structures.DocumentDiagnosticParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentDocumentColor — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_color.ex#L2 "View Source")

GenLSP.Requests.TextDocumentDocumentColor

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================

A request to list all color symbols found in a given text document. The request's

parameter is of type {@link DocumentColorParams} the

response is of type {@link ColorInformation ColorInformation[]} or a Thenable

that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_color.ex#L24 "View Source")

```

@type result() :: [[GenLSP.Structures.ColorInformation.t](GenLSP.Structures.ColorInformation.html#t:t/0)()]

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_color.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentDocumentColor{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DocumentColorParams.t](GenLSP.Structures.DocumentColorParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentDocumentHighlight — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_highlight.ex#L2 "View Source")

GenLSP.Requests.TextDocumentDocumentHighlight

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================

Request to resolve a {@link DocumentHighlight} for a given

text document position. The request's parameter is of type [TextDocumentPosition]

(#TextDocumentPosition) the request response is of type [DocumentHighlight[]]

(#DocumentHighlight) or a Thenable that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_highlight.ex#L24 "View Source")

```

@type result() :: [[GenLSP.Structures.DocumentHighlight.t](GenLSP.Structures.DocumentHighlight.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_highlight.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentDocumentHighlight{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DocumentHighlightParams.t](GenLSP.Structures.DocumentHighlightParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentDocumentLink — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_link.ex#L2 "View Source")

GenLSP.Requests.TextDocumentDocumentLink

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

A request to provide document links

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_link.ex#L21 "View Source")

```

@type result() :: [[GenLSP.Structures.DocumentLink.t](GenLSP.Structures.DocumentLink.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_link.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentDocumentLink{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DocumentLinkParams.t](GenLSP.Structures.DocumentLinkParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentDocumentSymbol — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_symbol.ex#L2 "View Source")

GenLSP.Requests.TextDocumentDocumentSymbol

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

A request to list all symbols found in a given text document. The request's

parameter is of type {@link TextDocumentIdentifier} the

response is of type {@link SymbolInformation SymbolInformation[]} or a Thenable

that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_symbol.ex#L24 "View Source")

```

@type result() ::

  [[GenLSP.Structures.SymbolInformation.t](GenLSP.Structures.SymbolInformation.html#t:t/0)()]

  | [[GenLSP.Structures.DocumentSymbol.t](GenLSP.Structures.DocumentSymbol.html#t:t/0)()]

  | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_document_symbol.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentDocumentSymbol{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DocumentSymbolParams.t](GenLSP.Structures.DocumentSymbolParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentFoldingRange — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_folding_range.ex#L2 "View Source")

GenLSP.Requests.TextDocumentFoldingRange

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

A request to provide folding ranges in a document. The request's

parameter is of type {@link FoldingRangeParams}, the

response is of type {@link FoldingRangeList} or a Thenable

that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_folding_range.ex#L24 "View Source")

```

@type result() :: [[GenLSP.Structures.FoldingRange.t](GenLSP.Structures.FoldingRange.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_folding_range.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentFoldingRange{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.FoldingRangeParams.t](GenLSP.Structures.FoldingRangeParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentFormatting — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_formatting.ex#L2 "View Source")

GenLSP.Requests.TextDocumentFormatting

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

A request to format a whole document.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_formatting.ex#L21 "View Source")

```

@type result() :: [[GenLSP.Structures.TextEdit.t](GenLSP.Structures.TextEdit.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_formatting.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentFormatting{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DocumentFormattingParams.t](GenLSP.Structures.DocumentFormattingParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentHover — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_hover.ex#L2 "View Source")

GenLSP.Requests.TextDocumentHover

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================

Request to request hover information at a given text document position. The request's

parameter is of type {@link TextDocumentPosition} the response is of

type {@link Hover} or a Thenable that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_hover.ex#L23 "View Source")

```

@type result() :: [GenLSP.Structures.Hover.t](GenLSP.Structures.Hover.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_hover.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentHover{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.HoverParams.t](GenLSP.Structures.HoverParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentImplementation — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_implementation.ex#L2 "View Source")

GenLSP.Requests.TextDocumentImplementation

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================

A request to resolve the implementation locations of a symbol at a given text

document position. The request's parameter is of type [TextDocumentPositionParams]

(#TextDocumentPositionParams) the response is of type {@link Definition} or a

Thenable that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_implementation.ex#L24 "View Source")

```

@type result() ::

  [GenLSP.TypeAlias.Definition.t](GenLSP.TypeAlias.Definition.html#t:t/0)() | [[GenLSP.TypeAlias.DefinitionLink.t](GenLSP.TypeAlias.DefinitionLink.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_implementation.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentImplementation{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.ImplementationParams.t](GenLSP.Structures.ImplementationParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentInlayHint — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_inlay_hint.ex#L2 "View Source")

GenLSP.Requests.TextDocumentInlayHint

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================

A request to provide inlay hints in a document. The request's parameter is of

type {@link InlayHintsParams}, the response is of type

{@link InlayHint InlayHint[]} or a Thenable that resolves to such.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_inlay_hint.ex#L25 "View Source")

```

@type result() :: [[GenLSP.Structures.InlayHint.t](GenLSP.Structures.InlayHint.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_inlay_hint.ex#L18 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentInlayHint{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.InlayHintParams.t](GenLSP.Structures.InlayHintParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentInlineValue — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_inline_value.ex#L2 "View Source")

GenLSP.Requests.TextDocumentInlineValue

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================================

A request to provide inline values in a document. The request's parameter is of

type {@link InlineValueParams}, the response is of type

{@link InlineValue InlineValue[]} or a Thenable that resolves to such.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_inline_value.ex#L25 "View Source")

```

@type result() :: [[GenLSP.TypeAlias.InlineValue.t](GenLSP.TypeAlias.InlineValue.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_inline_value.ex#L18 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentInlineValue{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.InlineValueParams.t](GenLSP.Structures.InlineValueParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentLinkedEditingRange — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_linked_editing_range.ex#L2 "View Source")

GenLSP.Requests.TextDocumentLinkedEditingRange

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================================

A request to provide ranges that can be edited together.

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_linked_editing_range.ex#L23 "View Source")

```

@type result() :: [GenLSP.Structures.LinkedEditingRanges.t](GenLSP.Structures.LinkedEditingRanges.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_linked_editing_range.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentLinkedEditingRange{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.LinkedEditingRangeParams.t](GenLSP.Structures.LinkedEditingRangeParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentMoniker — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_moniker.ex#L2 "View Source")

GenLSP.Requests.TextDocumentMoniker

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

A request to get the moniker of a symbol at a given text document position.

The request parameter is of type {@link TextDocumentPositionParams}.

The response is of type {@link Moniker Moniker[]} or `null`.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_moniker.ex#L23 "View Source")

```

@type result() :: [[GenLSP.Structures.Moniker.t](GenLSP.Structures.Moniker.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_moniker.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentMoniker{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.MonikerParams.t](GenLSP.Structures.MonikerParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentOnTypeFormatting — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_on_type_formatting.ex#L2 "View Source")

GenLSP.Requests.TextDocumentOnTypeFormatting

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================================

A request to format a document on type.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_on_type_formatting.ex#L21 "View Source")

```

@type result() :: [[GenLSP.Structures.TextEdit.t](GenLSP.Structures.TextEdit.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_on_type_formatting.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentOnTypeFormatting{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DocumentOnTypeFormattingParams.t](GenLSP.Structures.DocumentOnTypeFormattingParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentPrepareCallHierarchy — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_prepare_call_hierarchy.ex#L2 "View Source")

GenLSP.Requests.TextDocumentPrepareCallHierarchy

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================================

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.

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_prepare_call_hierarchy.ex#L24 "View Source")

```

@type result() :: [[GenLSP.Structures.CallHierarchyItem.t](GenLSP.Structures.CallHierarchyItem.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_prepare_call_hierarchy.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentPrepareCallHierarchy{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CallHierarchyPrepareParams.t](GenLSP.Structures.CallHierarchyPrepareParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentPrepareRename — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_prepare_rename.ex#L2 "View Source")

GenLSP.Requests.TextDocumentPrepareRename

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================

A request to test and perform the setup necessary for a rename.

@since 3.16 - support for default behavior

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_prepare_rename.ex#L23 "View Source")

```

@type result() :: [GenLSP.TypeAlias.PrepareRenameResult.t](GenLSP.TypeAlias.PrepareRenameResult.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_prepare_rename.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentPrepareRename{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.PrepareRenameParams.t](GenLSP.Structures.PrepareRenameParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentPrepareTypeHierarchy — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_prepare_type_hierarchy.ex#L2 "View Source")

GenLSP.Requests.TextDocumentPrepareTypeHierarchy

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================================

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.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_prepare_type_hierarchy.ex#L24 "View Source")

```

@type result() :: [[GenLSP.Structures.TypeHierarchyItem.t](GenLSP.Structures.TypeHierarchyItem.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_prepare_type_hierarchy.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentPrepareTypeHierarchy{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.TypeHierarchyPrepareParams.t](GenLSP.Structures.TypeHierarchyPrepareParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentRangeFormatting — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_range_formatting.ex#L2 "View Source")

GenLSP.Requests.TextDocumentRangeFormatting

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================

A request to format a range in a document.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_range_formatting.ex#L21 "View Source")

```

@type result() :: [[GenLSP.Structures.TextEdit.t](GenLSP.Structures.TextEdit.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_range_formatting.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentRangeFormatting{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DocumentRangeFormattingParams.t](GenLSP.Structures.DocumentRangeFormattingParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentReferences — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_references.ex#L2 "View Source")

GenLSP.Requests.TextDocumentReferences

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

A request to resolve project-wide references for the symbol denoted

by the given text document position. The request's parameter is of

type {@link ReferenceParams} the response is of type

{@link Location Location[]} or a Thenable that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_references.ex#L24 "View Source")

```

@type result() :: [[GenLSP.Structures.Location.t](GenLSP.Structures.Location.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_references.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentReferences{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.ReferenceParams.t](GenLSP.Structures.ReferenceParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentRename — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_rename.ex#L2 "View Source")

GenLSP.Requests.TextDocumentRename

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

A request to rename a symbol.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_rename.ex#L21 "View Source")

```

@type result() :: [GenLSP.Structures.WorkspaceEdit.t](GenLSP.Structures.WorkspaceEdit.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_rename.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentRename{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.RenameParams.t](GenLSP.Structures.RenameParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentSelectionRange — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_selection_range.ex#L2 "View Source")

GenLSP.Requests.TextDocumentSelectionRange

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

A request to provide selection ranges in a document. The request's

parameter is of type {@link SelectionRangeParams}, the

response is of type {@link SelectionRange SelectionRange[]} or a Thenable

that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_selection_range.ex#L24 "View Source")

```

@type result() :: [[GenLSP.Structures.SelectionRange.t](GenLSP.Structures.SelectionRange.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_selection_range.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentSelectionRange{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.SelectionRangeParams.t](GenLSP.Structures.SelectionRangeParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentSemanticTokensFull — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_semantic_tokens_full.ex#L2 "View Source")

GenLSP.Requests.TextDocumentSemanticTokensFull

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================================

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_semantic_tokens_full.ex#L21 "View Source")

```

@type result() :: [GenLSP.Structures.SemanticTokens.t](GenLSP.Structures.SemanticTokens.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_semantic_tokens_full.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentSemanticTokensFull{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.SemanticTokensParams.t](GenLSP.Structures.SemanticTokensParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentSemanticTokensFullDelta — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_semantic_tokens_full_delta.ex#L2 "View Source")

GenLSP.Requests.TextDocumentSemanticTokensFullDelta

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================================

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_semantic_tokens_full_delta.ex#L21 "View Source")

```

@type result() ::

  [GenLSP.Structures.SemanticTokens.t](GenLSP.Structures.SemanticTokens.html#t:t/0)()

  | [GenLSP.Structures.SemanticTokensDelta.t](GenLSP.Structures.SemanticTokensDelta.html#t:t/0)()

  | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_semantic_tokens_full_delta.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentSemanticTokensFullDelta{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.SemanticTokensDeltaParams.t](GenLSP.Structures.SemanticTokensDeltaParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentSemanticTokensRange — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_semantic_tokens_range.ex#L2 "View Source")

GenLSP.Requests.TextDocumentSemanticTokensRange

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================================

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_semantic_tokens_range.ex#L21 "View Source")

```

@type result() :: [GenLSP.Structures.SemanticTokens.t](GenLSP.Structures.SemanticTokens.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_semantic_tokens_range.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentSemanticTokensRange{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.SemanticTokensRangeParams.t](GenLSP.Structures.SemanticTokensRangeParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentSignatureHelp — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_signature_help.ex#L2 "View Source")

GenLSP.Requests.TextDocumentSignatureHelp

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_signature_help.ex#L15 "View Source")

```

@type result() :: [GenLSP.Structures.SignatureHelp.t](GenLSP.Structures.SignatureHelp.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_signature_help.ex#L8 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentSignatureHelp{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.SignatureHelpParams.t](GenLSP.Structures.SignatureHelpParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentTypeDefinition — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_type_definition.ex#L2 "View Source")

GenLSP.Requests.TextDocumentTypeDefinition

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

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]

(#TextDocumentPositionParams) the response is of type {@link Definition} or a

Thenable that resolves to such.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_type_definition.ex#L24 "View Source")

```

@type result() ::

  [GenLSP.TypeAlias.Definition.t](GenLSP.TypeAlias.Definition.html#t:t/0)() | [[GenLSP.TypeAlias.DefinitionLink.t](GenLSP.TypeAlias.DefinitionLink.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_type_definition.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentTypeDefinition{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.TypeDefinitionParams.t](GenLSP.Structures.TypeDefinitionParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TextDocumentWillSaveWaitUntil — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_will_save_wait_until.ex#L2 "View Source")

GenLSP.Requests.TextDocumentWillSaveWaitUntil

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================

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.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_will_save_wait_until.ex#L26 "View Source")

```

@type result() :: [[GenLSP.Structures.TextEdit.t](GenLSP.Structures.TextEdit.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/text_document_will_save_wait_until.ex#L19 "View Source")

```

@type t() :: %GenLSP.Requests.TextDocumentWillSaveWaitUntil{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.WillSaveTextDocumentParams.t](GenLSP.Structures.WillSaveTextDocumentParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TypeHierarchySubtypes — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/type_hierarchy_subtypes.ex#L2 "View Source")

GenLSP.Requests.TypeHierarchySubtypes

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

A request to resolve the subtypes for a given `TypeHierarchyItem`.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/type_hierarchy_subtypes.ex#L23 "View Source")

```

@type result() :: [[GenLSP.Structures.TypeHierarchyItem.t](GenLSP.Structures.TypeHierarchyItem.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/type_hierarchy_subtypes.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.TypeHierarchySubtypes{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.TypeHierarchySubtypesParams.t](GenLSP.Structures.TypeHierarchySubtypesParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.TypeHierarchySupertypes — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/type_hierarchy_supertypes.ex#L2 "View Source")

GenLSP.Requests.TypeHierarchySupertypes

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================

A request to resolve the supertypes for a given `TypeHierarchyItem`.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/type_hierarchy_supertypes.ex#L23 "View Source")

```

@type result() :: [[GenLSP.Structures.TypeHierarchyItem.t](GenLSP.Structures.TypeHierarchyItem.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/type_hierarchy_supertypes.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.TypeHierarchySupertypes{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.TypeHierarchySupertypesParams.t](GenLSP.Structures.TypeHierarchySupertypesParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WindowShowDocument — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/window_show_document.ex#L2 "View Source")

GenLSP.Requests.WindowShowDocument

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

A request to show a document. This request might open an

external program depending on the value of the URI to open.

For example a request to open `https://code.visualstudio.com/`

will very likely open the URI in a WEB browser.

@since 3.16.0

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/window_show_document.ex#L26 "View Source")

```

@type result() :: [GenLSP.Structures.ShowDocumentResult.t](GenLSP.Structures.ShowDocumentResult.html#t:t/0)()

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/window_show_document.ex#L19 "View Source")

```

@type t() :: %GenLSP.Requests.WindowShowDocument{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.ShowDocumentParams.t](GenLSP.Structures.ShowDocumentParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WindowShowMessageRequest — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/window_show_message_request.ex#L2 "View Source")

GenLSP.Requests.WindowShowMessageRequest

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

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.

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/window_show_message_request.ex#L22 "View Source")

```

@type result() :: [GenLSP.Structures.MessageActionItem.t](GenLSP.Structures.MessageActionItem.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/window_show_message_request.ex#L15 "View Source")

```

@type t() :: %GenLSP.Requests.WindowShowMessageRequest{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.ShowMessageRequestParams.t](GenLSP.Structures.ShowMessageRequestParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WindowWorkDoneProgressCreate — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/window_work_done_progress_create.ex#L2 "View Source")

GenLSP.Requests.WindowWorkDoneProgressCreate

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================================

The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress

reporting from the server.

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/window_work_done_progress_create.ex#L22 "View Source")

```

@type result() :: nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/window_work_done_progress_create.ex#L15 "View Source")

```

@type t() :: %GenLSP.Requests.WindowWorkDoneProgressCreate{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.WorkDoneProgressCreateParams.t](GenLSP.Structures.WorkDoneProgressCreateParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WorkspaceApplyEdit — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_apply_edit.ex#L2 "View Source")

GenLSP.Requests.WorkspaceApplyEdit

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

A request sent from the server to the client to modified certain resources.

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_apply_edit.ex#L21 "View Source")

```

@type result() :: [GenLSP.Structures.ApplyWorkspaceEditResult.t](GenLSP.Structures.ApplyWorkspaceEditResult.html#t:t/0)()

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_apply_edit.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceApplyEdit{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.ApplyWorkspaceEditParams.t](GenLSP.Structures.ApplyWorkspaceEditParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WorkspaceCodeLensRefresh — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_code_lens_refresh.ex#L2 "View Source")

GenLSP.Requests.WorkspaceCodeLensRefresh

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

A request to refresh all code actions

@since 3.16.0

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_code_lens_refresh.ex#L22 "View Source")

```

@type result() :: nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_code_lens_refresh.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceCodeLensRefresh{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```





GenLSP.Requests.WorkspaceConfiguration — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_configuration.ex#L2 "View Source")

GenLSP.Requests.WorkspaceConfiguration

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================

The 'workspace/configuration' request is sent from the server to the client to fetch a certain

configuration setting.

This pull model replaces the old push model were the client signaled configuration change via an

event. If the server still needs to react to configuration changes (since the server caches the

result of `workspace/configuration` requests) the server should register for an empty configuration

change event and empty the cache if such an event is received.

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_configuration.ex#L27 "View Source")

```

@type result() :: [[GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)()]

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_configuration.ex#L20 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceConfiguration{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.ConfigurationParams.t](GenLSP.Structures.ConfigurationParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WorkspaceDiagnostic — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_diagnostic.ex#L2 "View Source")

GenLSP.Requests.WorkspaceDiagnostic

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

The workspace diagnostic request definition.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_diagnostic.ex#L23 "View Source")

```

@type result() :: [GenLSP.Structures.WorkspaceDiagnosticReport.t](GenLSP.Structures.WorkspaceDiagnosticReport.html#t:t/0)()

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_diagnostic.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceDiagnostic{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.WorkspaceDiagnosticParams.t](GenLSP.Structures.WorkspaceDiagnosticParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WorkspaceDiagnosticRefresh — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_diagnostic_refresh.ex#L2 "View Source")

GenLSP.Requests.WorkspaceDiagnosticRefresh

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================

The diagnostic refresh request definition.

@since 3.17.0

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_diagnostic_refresh.ex#L22 "View Source")

```

@type result() :: nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_diagnostic_refresh.ex#L16 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceDiagnosticRefresh{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```





GenLSP.Requests.WorkspaceExecuteCommand — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_execute_command.ex#L2 "View Source")

GenLSP.Requests.WorkspaceExecuteCommand

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================

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.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_execute_command.ex#L22 "View Source")

```

@type result() :: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_execute_command.ex#L15 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceExecuteCommand{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.ExecuteCommandParams.t](GenLSP.Structures.ExecuteCommandParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WorkspaceInlayHintRefresh — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_inlay_hint_refresh.ex#L2 "View Source")

GenLSP.Requests.WorkspaceInlayHintRefresh

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================

@since 3.17.0

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_inlay_hint_refresh.ex#L20 "View Source")

```

@type result() :: nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_inlay_hint_refresh.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceInlayHintRefresh{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```





GenLSP.Requests.WorkspaceInlineValueRefresh — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_inline_value_refresh.ex#L2 "View Source")

GenLSP.Requests.WorkspaceInlineValueRefresh

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================

@since 3.17.0

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_inline_value_refresh.ex#L20 "View Source")

```

@type result() :: nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_inline_value_refresh.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceInlineValueRefresh{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```





GenLSP.Requests.WorkspaceSemanticTokensRefresh — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_semantic_tokens_refresh.ex#L2 "View Source")

GenLSP.Requests.WorkspaceSemanticTokensRefresh

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================

@since 3.16.0

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_semantic_tokens_refresh.ex#L20 "View Source")

```

@type result() :: nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_semantic_tokens_refresh.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceSemanticTokensRefresh{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```





GenLSP.Requests.WorkspaceSymbol — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_symbol.ex#L2 "View Source")

GenLSP.Requests.WorkspaceSymbol

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================

A request to list project-wide symbols matching the query string given

by the {@link WorkspaceSymbolParams}. The response is

of type {@link SymbolInformation SymbolInformation[]} or a Thenable that

resolves to such.

@since 3.17.0 - support for WorkspaceSymbol in the returned data. Clients

 need to advertise support for WorkspaceSymbols via the client capability

 `workspace.symbol.resolveSupport`.

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_symbol.ex#L29 "View Source")

```

@type result() ::

  [[GenLSP.Structures.SymbolInformation.t](GenLSP.Structures.SymbolInformation.html#t:t/0)()]

  | [[GenLSP.Structures.WorkspaceSymbol.t](GenLSP.Structures.WorkspaceSymbol.html#t:t/0)()]

  | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_symbol.ex#L22 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceSymbol{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.WorkspaceSymbolParams.t](GenLSP.Structures.WorkspaceSymbolParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WorkspaceSymbolResolve — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_symbol_resolve.ex#L2 "View Source")

GenLSP.Requests.WorkspaceSymbolResolve

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

A request to resolve the range inside the workspace

symbol's location.

@since 3.17.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_symbol_resolve.ex#L24 "View Source")

```

@type result() :: [GenLSP.Structures.WorkspaceSymbol.t](GenLSP.Structures.WorkspaceSymbol.html#t:t/0)()

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_symbol_resolve.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceSymbolResolve{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.WorkspaceSymbol.t](GenLSP.Structures.WorkspaceSymbol.html#t:t/0)() | nil

}

```





GenLSP.Requests.WorkspaceWillCreateFiles — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_will_create_files.ex#L2 "View Source")

GenLSP.Requests.WorkspaceWillCreateFiles

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

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.

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_will_create_files.ex#L24 "View Source")

```

@type result() :: [GenLSP.Structures.WorkspaceEdit.t](GenLSP.Structures.WorkspaceEdit.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_will_create_files.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceWillCreateFiles{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.CreateFilesParams.t](GenLSP.Structures.CreateFilesParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WorkspaceWillDeleteFiles — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_will_delete_files.ex#L2 "View Source")

GenLSP.Requests.WorkspaceWillDeleteFiles

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

The did delete files notification is sent from the client to the server when

files were deleted from within the client.

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_will_delete_files.ex#L24 "View Source")

```

@type result() :: [GenLSP.Structures.WorkspaceEdit.t](GenLSP.Structures.WorkspaceEdit.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_will_delete_files.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceWillDeleteFiles{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.DeleteFilesParams.t](GenLSP.Structures.DeleteFilesParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WorkspaceWillRenameFiles — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_will_rename_files.ex#L2 "View Source")

GenLSP.Requests.WorkspaceWillRenameFiles

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

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.

@since 3.16.0

Message Direction: clientToServer

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_will_rename_files.ex#L24 "View Source")

```

@type result() :: [GenLSP.Structures.WorkspaceEdit.t](GenLSP.Structures.WorkspaceEdit.html#t:t/0)() | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_will_rename_files.ex#L17 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceWillRenameFiles{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  params: [GenLSP.Structures.RenameFilesParams.t](GenLSP.Structures.RenameFilesParams.html#t:t/0)() | nil

}

```





GenLSP.Requests.WorkspaceWorkspaceFolders — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_workspace_folders.ex#L2 "View Source")

GenLSP.Requests.WorkspaceWorkspaceFolders

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================

The `workspace/workspaceFolders` is sent from the server to the client to fetch the open workspace folders.

Message Direction: serverToClient

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[result()](#t:result/0)

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:result/0 "Link to this type")

result()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_workspace_folders.ex#L20 "View Source")

```

@type result() :: [[GenLSP.Structures.WorkspaceFolder.t](GenLSP.Structures.WorkspaceFolder.html#t:t/0)()] | nil

```

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/requests/workspace_workspace_folders.ex#L14 "View Source")

```

@type t() :: %GenLSP.Requests.WorkspaceWorkspaceFolders{

  id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  jsonrpc: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```





GenLSP.Structures.AnnotatedTextEdit — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/annotated_text_edit.ex#L2 "View Source")

GenLSP.Structures.AnnotatedTextEdit

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

A special text edit with an additional change annotation.

@since 3.16.0.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.AnnotatedTextEdit{}](#__struct__/0)

Fields

------

* annotation\_id: The actual identifier of the change annotation

* range: The range of the text document to be manipulated. To insert

text into a document create a range where start === end.

* new\_text: The string to be inserted. For delete operations use an

empty string.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/annotated_text_edit.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.AnnotatedTextEdit{

  annotation_id: [GenLSP.TypeAlias.ChangeAnnotationIdentifier.t](GenLSP.TypeAlias.ChangeAnnotationIdentifier.html#t:t/0)(),

  new_text: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.AnnotatedTextEdit{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/annotated_text_edit.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* annotation\_id: The actual identifier of the change annotation

* range: The range of the text document to be manipulated. To insert

text into a document create a range where start === end.

* new\_text: The string to be inserted. For delete operations use an

empty string.





GenLSP.Structures.ApplyWorkspaceEditParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/apply_workspace_edit_params.ex#L2 "View Source")

GenLSP.Structures.ApplyWorkspaceEditParams

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

The parameters passed via an apply workspace edit request.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ApplyWorkspaceEditParams{}](#__struct__/0)

Fields

------

* label: An optional label of the workspace edit. This label is

presented in the user interface for example on an undo

stack to undo the workspace edit.

* edit: The edits to apply.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/apply_workspace_edit_params.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.ApplyWorkspaceEditParams{

  edit: [GenLSP.Structures.WorkspaceEdit.t](GenLSP.Structures.WorkspaceEdit.html#t:t/0)(),

  label: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ApplyWorkspaceEditParams{}

=============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/apply_workspace_edit_params.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* label: An optional label of the workspace edit. This label is

presented in the user interface for example on an undo

stack to undo the workspace edit.

* edit: The edits to apply.





GenLSP.Structures.ApplyWorkspaceEditResult — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/apply_workspace_edit_result.ex#L2 "View Source")

GenLSP.Structures.ApplyWorkspaceEditResult

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

The result returned from the apply workspace edit request.

@since 3.17 renamed from ApplyWorkspaceEditResponse

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ApplyWorkspaceEditResult{}](#__struct__/0)

Fields

------

* applied: Indicates whether the edit was applied or not.

* failure\_reason: An optional textual description for why the edit was not applied.

This may be used by the server for diagnostic logging or to provide

a suitable error for a request that triggered the edit.

* failed\_change: Depending on the client's failure handling strategy `failedChange` might

contain the index of the change that failed. This property is only available

if the client signals a `failureHandlingStrategy` in its client capabilities.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/apply_workspace_edit_result.ex#L25 "View Source")

```

@type t() :: %GenLSP.Structures.ApplyWorkspaceEditResult{

  applied: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)(),

  failed_change: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)() | nil,

  failure_reason: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ApplyWorkspaceEditResult{}

=============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/apply_workspace_edit_result.ex#L25 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* applied: Indicates whether the edit was applied or not.

* failure\_reason: An optional textual description for why the edit was not applied.

This may be used by the server for diagnostic logging or to provide

a suitable error for a request that triggered the edit.

* failed\_change: Depending on the client's failure handling strategy `failedChange` might

contain the index of the change that failed. This property is only available

if the client signals a `failureHandlingStrategy` in its client capabilities.





GenLSP.Structures.BaseSymbolInformation — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/base_symbol_information.ex#L2 "View Source")

GenLSP.Structures.BaseSymbolInformation

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================

A base for all symbol information.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.BaseSymbolInformation{}](#__struct__/0)

Fields

------

* name: The name of this symbol.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/base_symbol_information.ex#L25 "View Source")

```

@type t() :: %GenLSP.Structures.BaseSymbolInformation{

  container_name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  kind: [GenLSP.Enumerations.SymbolKind.t](GenLSP.Enumerations.SymbolKind.html#t:t/0)(),

  name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  tags: [[GenLSP.Enumerations.SymbolTag.t](GenLSP.Enumerations.SymbolTag.html#t:t/0)()] | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.BaseSymbolInformation{}

==========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/base_symbol_information.ex#L25 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* name: The name of this symbol.

* kind: The kind of this symbol.

* tags: Tags for this symbol.

@since 3.16.0

* container\_name: The name of the symbol containing this symbol. This information is for

user interface purposes (e.g. to render a qualifier in the user interface

if necessary). It can't be used to re-infer a hierarchy for the document

symbols.





GenLSP.Structures.CallHierarchyClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.CallHierarchyClientCapabilities

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CallHierarchyClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_client_capabilities.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.CallHierarchyClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CallHierarchyClientCapabilities{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_client_capabilities.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.





GenLSP.Structures.CallHierarchyIncomingCall — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_incoming_call.ex#L2 "View Source")

GenLSP.Structures.CallHierarchyIncomingCall

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================

Represents an incoming call, e.g. a caller of a method or constructor.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CallHierarchyIncomingCall{}](#__struct__/0)

Fields

------

* from: The item that makes the call.

* from\_ranges: The ranges at which the calls appear. This is relative to the caller

denoted by {@link CallHierarchyIncomingCall.from `this.from`}.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_incoming_call.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.CallHierarchyIncomingCall{

  from: [GenLSP.Structures.CallHierarchyItem.t](GenLSP.Structures.CallHierarchyItem.html#t:t/0)(),

  from_ranges: [[GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CallHierarchyIncomingCall{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_incoming_call.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* from: The item that makes the call.

* from\_ranges: The ranges at which the calls appear. This is relative to the caller

denoted by {@link CallHierarchyIncomingCall.from `this.from`}.





GenLSP.Structures.CallHierarchyIncomingCallsParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_incoming_calls_params.ex#L2 "View Source")

GenLSP.Structures.CallHierarchyIncomingCallsParams

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================================

The parameter of a `callHierarchy/incomingCalls` request.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CallHierarchyIncomingCallsParams{}](#__struct__/0)

Fields

------

* item

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_incoming_calls_params.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.CallHierarchyIncomingCallsParams{

  item: [GenLSP.Structures.CallHierarchyItem.t](GenLSP.Structures.CallHierarchyItem.html#t:t/0)(),

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CallHierarchyIncomingCallsParams{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_incoming_calls_params.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* item

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.CallHierarchyItem — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_item.ex#L2 "View Source")

GenLSP.Structures.CallHierarchyItem

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

Represents programming constructs like functions or constructors in the context

of call hierarchy.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CallHierarchyItem{}](#__struct__/0)

Fields

------

* name: The name of this item.

* kind: The kind of this item.

* tags: Tags for this item.

* detail: More detail for this item, e.g. the signature of a function.

* uri: The resource identifier of this item.

* range: The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

* selection\_range: The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function.

Must be contained by the {@link CallHierarchyItem.range `range`}.

* data: A data entry field that is preserved between a call hierarchy prepare and

incoming calls or outgoing calls requests.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_item.ex#L29 "View Source")

```

@type t() :: %GenLSP.Structures.CallHierarchyItem{

  data: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  detail: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  kind: [GenLSP.Enumerations.SymbolKind.t](GenLSP.Enumerations.SymbolKind.html#t:t/0)(),

  name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  selection_range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  tags: [[GenLSP.Enumerations.SymbolTag.t](GenLSP.Enumerations.SymbolTag.html#t:t/0)()] | nil,

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CallHierarchyItem{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_item.ex#L29 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* name: The name of this item.

* kind: The kind of this item.

* tags: Tags for this item.

* detail: More detail for this item, e.g. the signature of a function.

* uri: The resource identifier of this item.

* range: The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.

* selection\_range: The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function.

Must be contained by the {@link CallHierarchyItem.range `range`}.

* data: A data entry field that is preserved between a call hierarchy prepare and

incoming calls or outgoing calls requests.





GenLSP.Structures.CallHierarchyOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_options.ex#L2 "View Source")

GenLSP.Structures.CallHierarchyOptions

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

Call hierarchy options used during static registration.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CallHierarchyOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_options.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.CallHierarchyOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CallHierarchyOptions{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_options.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.CallHierarchyOutgoingCall — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_outgoing_call.ex#L2 "View Source")

GenLSP.Structures.CallHierarchyOutgoingCall

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================

Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CallHierarchyOutgoingCall{}](#__struct__/0)

Fields

------

* to: The item that is called.

* from\_ranges: The range at which this item is called. This is the range relative to the caller, e.g the item

passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`}

and not {@link CallHierarchyOutgoingCall.to `this.to`}.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_outgoing_call.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.CallHierarchyOutgoingCall{

  from_ranges: [[GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()],

  to: [GenLSP.Structures.CallHierarchyItem.t](GenLSP.Structures.CallHierarchyItem.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CallHierarchyOutgoingCall{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_outgoing_call.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* to: The item that is called.

* from\_ranges: The range at which this item is called. This is the range relative to the caller, e.g the item

passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`}

and not {@link CallHierarchyOutgoingCall.to `this.to`}.





GenLSP.Structures.CallHierarchyOutgoingCallsParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_outgoing_calls_params.ex#L2 "View Source")

GenLSP.Structures.CallHierarchyOutgoingCallsParams

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================================

The parameter of a `callHierarchy/outgoingCalls` request.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CallHierarchyOutgoingCallsParams{}](#__struct__/0)

Fields

------

* item

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_outgoing_calls_params.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.CallHierarchyOutgoingCallsParams{

  item: [GenLSP.Structures.CallHierarchyItem.t](GenLSP.Structures.CallHierarchyItem.html#t:t/0)(),

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CallHierarchyOutgoingCallsParams{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_outgoing_calls_params.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* item

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.CallHierarchyPrepareParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_prepare_params.ex#L2 "View Source")

GenLSP.Structures.CallHierarchyPrepareParams

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

The parameter of a `textDocument/prepareCallHierarchy` request.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CallHierarchyPrepareParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_prepare_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.CallHierarchyPrepareParams{

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CallHierarchyPrepareParams{}

===============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_prepare_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.CallHierarchyRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_registration_options.ex#L2 "View Source")

GenLSP.Structures.CallHierarchyRegistrationOptions

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

Call hierarchy options used during static or dynamic registration.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CallHierarchyRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_registration_options.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.CallHierarchyRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CallHierarchyRegistrationOptions{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/call_hierarchy_registration_options.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.CancelParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/cancel_params.ex#L2 "View Source")

GenLSP.Structures.CancelParams

(gen\_lsp v0.6.0)

================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CancelParams{}](#__struct__/0)

Fields

------

* id: The request id to cancel.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/cancel_params.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.CancelParams{id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CancelParams{}

=================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/cancel_params.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The request id to cancel.





GenLSP.Structures.ChangeAnnotation — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/change_annotation.ex#L2 "View Source")

GenLSP.Structures.ChangeAnnotation

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================

Additional information that describes document changes.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ChangeAnnotation{}](#__struct__/0)

Fields

------

* label: A human-readable string describing the actual change. The string

is rendered prominent in the user interface.

* needs\_confirmation: A flag which indicates that user confirmation is needed

before applying the change.

* description: A human-readable string which is rendered less prominent in

the user interface.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/change_annotation.ex#L24 "View Source")

```

@type t() :: %GenLSP.Structures.ChangeAnnotation{

  description: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  label: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  needs_confirmation: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ChangeAnnotation{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/change_annotation.ex#L24 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* label: A human-readable string describing the actual change. The string

is rendered prominent in the user interface.

* needs\_confirmation: A flag which indicates that user confirmation is needed

before applying the change.

* description: A human-readable string which is rendered less prominent in

the user interface.





GenLSP.Structures.ClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/client_capabilities.ex#L2 "View Source")

GenLSP.Structures.ClientCapabilities

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================

Defines the capabilities provided by the client.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ClientCapabilities{}](#__struct__/0)

Fields

------

* workspace: Workspace specific client capabilities.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/client_capabilities.ex#L26 "View Source")

```

@type t() :: %GenLSP.Structures.ClientCapabilities{

  experimental: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  general: [GenLSP.Structures.GeneralClientCapabilities.t](GenLSP.Structures.GeneralClientCapabilities.html#t:t/0)() | nil,

  notebook_document:

    [GenLSP.Structures.NotebookDocumentClientCapabilities.t](GenLSP.Structures.NotebookDocumentClientCapabilities.html#t:t/0)() | nil,

  text_document: [GenLSP.Structures.TextDocumentClientCapabilities.t](GenLSP.Structures.TextDocumentClientCapabilities.html#t:t/0)() | nil,

  window: [GenLSP.Structures.WindowClientCapabilities.t](GenLSP.Structures.WindowClientCapabilities.html#t:t/0)() | nil,

  workspace: [GenLSP.Structures.WorkspaceClientCapabilities.t](GenLSP.Structures.WorkspaceClientCapabilities.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ClientCapabilities{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/client_capabilities.ex#L26 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* workspace: Workspace specific client capabilities.

* text\_document: Text document specific client capabilities.

* notebook\_document: Capabilities specific to the notebook document support.

@since 3.17.0

* window: Window specific client capabilities.

* general: General client capabilities.

@since 3.16.0

* experimental: Experimental client capabilities.





GenLSP.Structures.CodeAction — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action.ex#L2 "View Source")

GenLSP.Structures.CodeAction

(gen\_lsp v0.6.0)

============================================================================================================================================================================================

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

to refactor code.

A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeAction{}](#__struct__/0)

Fields

------

* title: A short, human-readable, title for this code action.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action.ex#L54 "View Source")

```

@type t() :: %GenLSP.Structures.CodeAction{

  command: [GenLSP.Structures.Command.t](GenLSP.Structures.Command.html#t:t/0)() | nil,

  data: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  diagnostics: [[GenLSP.Structures.Diagnostic.t](GenLSP.Structures.Diagnostic.html#t:t/0)()] | nil,

  disabled: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  edit: [GenLSP.Structures.WorkspaceEdit.t](GenLSP.Structures.WorkspaceEdit.html#t:t/0)() | nil,

  is_preferred: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  kind: [GenLSP.Enumerations.CodeActionKind.t](GenLSP.Enumerations.CodeActionKind.html#t:t/0)() | nil,

  title: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeAction{}

===============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action.ex#L54 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* title: A short, human-readable, title for this code action.

* kind: The kind of the code action.

Used to filter code actions.

* diagnostics: The diagnostics that this code action resolves.

* is\_preferred: Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted

by keybindings.

A quick fix should be marked preferred if it properly addresses the underlying error.

A refactoring should be marked preferred if it is the most reasonable choice of actions to take.

@since 3.15.0

* disabled: Marks that the code action cannot currently be applied.

Clients should follow the following guidelines regarding disabled code actions:

	+ Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action)

	code action menus.

	+ Disabled actions are shown as faded out in the code action menu when the user requests a more specific type

	of code action, such as refactorings.

	+ If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions)

	that auto applies a code action and only disabled code actions are returned, the client should show the user an

	error message with `reason` in the editor.@since 3.16.0

* edit: The workspace edit this code action performs.

* command: A command this code action executes. If a code action

provides an edit and a command, first the edit is

executed and then the command.

* data: A data entry field that is preserved on a code action between

a `textDocument/codeAction` and a `codeAction/resolve` request.

@since 3.16.0





GenLSP.Structures.CodeActionClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.CodeActionClientCapabilities

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================

The Client Capabilities of a {@link CodeActionRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeActionClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether code action supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_client_capabilities.ex#L44 "View Source")

```

@type t() :: %GenLSP.Structures.CodeActionClientCapabilities{

  code_action_literal_support: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  data_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  disabled_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  honors_change_annotations: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  is_preferred_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  resolve_support: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeActionClientCapabilities{}

=================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_client_capabilities.ex#L44 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether code action supports dynamic registration.

* code\_action\_literal\_support: The client support code action literals of type `CodeAction` as a valid

response of the `textDocument/codeAction` request. If the property is not

set the request can only return `Command` literals.

@since 3.8.0

* is\_preferred\_support: Whether code action supports the `isPreferred` property.

@since 3.15.0

* disabled\_support: Whether code action supports the `disabled` property.

@since 3.16.0

* data\_support: Whether code action supports the `data` property which is

preserved between a `textDocument/codeAction` and a

`codeAction/resolve` request.

@since 3.16.0

* resolve\_support: Whether the client supports resolving additional code action

properties via a separate `codeAction/resolve` request.

@since 3.16.0

* honors\_change\_annotations: Whether the client honors the change annotations in

text edits and resource operations returned via the

`CodeAction#edit` property by for example presenting

the workspace edit in the user interface and asking

for confirmation.

@since 3.16.0





GenLSP.Structures.CodeActionContext — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_context.ex#L2 "View Source")

GenLSP.Structures.CodeActionContext

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

Contains additional diagnostic information about the context in which

a {@link CodeActionProvider.provideCodeActions code action} is run.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeActionContext{}](#__struct__/0)

Fields

------

* diagnostics: An array of diagnostics known on the client side overlapping the range provided to the

`textDocument/codeAction` request. They are provided so that the server knows which

errors are currently presented to the user for the given range. There is no guarantee

that these accurately reflect the error state of the resource. The primary parameter

to compute code actions is the provided range.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_context.ex#L29 "View Source")

```

@type t() :: %GenLSP.Structures.CodeActionContext{

  diagnostics: [[GenLSP.Structures.Diagnostic.t](GenLSP.Structures.Diagnostic.html#t:t/0)()],

  only: [[GenLSP.Enumerations.CodeActionKind.t](GenLSP.Enumerations.CodeActionKind.html#t:t/0)()] | nil,

  trigger_kind: [GenLSP.Enumerations.CodeActionTriggerKind.t](GenLSP.Enumerations.CodeActionTriggerKind.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeActionContext{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_context.ex#L29 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* diagnostics: An array of diagnostics known on the client side overlapping the range provided to the

`textDocument/codeAction` request. They are provided so that the server knows which

errors are currently presented to the user for the given range. There is no guarantee

that these accurately reflect the error state of the resource. The primary parameter

to compute code actions is the provided range.

* only: Requested kind of actions to return.

Actions not of this kind are filtered out by the client before being shown. So servers

can omit computing them.

* trigger\_kind: The reason why code actions were requested.

@since 3.17.0





GenLSP.Structures.CodeActionOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_options.ex#L2 "View Source")

GenLSP.Structures.CodeActionOptions

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

Provider options for a {@link CodeActionRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeActionOptions{}](#__struct__/0)

Fields

------

* code\_action\_kinds: CodeActionKinds that this server may return.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_options.ex#L25 "View Source")

```

@type t() :: %GenLSP.Structures.CodeActionOptions{

  code_action_kinds: [[GenLSP.Enumerations.CodeActionKind.t](GenLSP.Enumerations.CodeActionKind.html#t:t/0)()] | nil,

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeActionOptions{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_options.ex#L25 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* code\_action\_kinds: CodeActionKinds that this server may return.

The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server

may list out every specific kind they provide.

* resolve\_provider: The server provides support to resolve additional

information for a code action.

@since 3.16.0

* work\_done\_progress





GenLSP.Structures.CodeActionParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_params.ex#L2 "View Source")

GenLSP.Structures.CodeActionParams

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

The parameters of a {@link CodeActionRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeActionParams{}](#__struct__/0)

Fields

------

* text\_document: The document in which the command was invoked.

* range: The range for which the command was invoked.

* context: Context carrying additional information.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_params.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.CodeActionParams{

  context: [GenLSP.Structures.CodeActionContext.t](GenLSP.Structures.CodeActionContext.html#t:t/0)(),

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeActionParams{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_params.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document in which the command was invoked.

* range: The range for which the command was invoked.

* context: Context carrying additional information.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.CodeActionRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_registration_options.ex#L2 "View Source")

GenLSP.Structures.CodeActionRegistrationOptions

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================================================

Registration options for a {@link CodeActionRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeActionRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_registration_options.ex#L26 "View Source")

```

@type t() :: %GenLSP.Structures.CodeActionRegistrationOptions{

  code_action_kinds: [[GenLSP.Enumerations.CodeActionKind.t](GenLSP.Enumerations.CodeActionKind.html#t:t/0)()] | nil,

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeActionRegistrationOptions{}

==================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_action_registration_options.ex#L26 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* code\_action\_kinds: CodeActionKinds that this server may return.

The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server

may list out every specific kind they provide.

* resolve\_provider: The server provides support to resolve additional

information for a code action.

@since 3.16.0





GenLSP.Structures.CodeDescription — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_description.ex#L2 "View Source")

GenLSP.Structures.CodeDescription

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================

Structure to capture a description for an error code.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeDescription{}](#__struct__/0)

Fields

------

* href: An URI to open with more information about the diagnostic error.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_description.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.CodeDescription{href: [GenLSP.BaseTypes.uri](GenLSP.BaseTypes.html#t:uri/0)()}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeDescription{}

====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_description.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* href: An URI to open with more information about the diagnostic error.





GenLSP.Structures.CodeLens — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens.ex#L2 "View Source")

GenLSP.Structures.CodeLens

(gen\_lsp v0.6.0)

========================================================================================================================================================================================

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.

A code lens is *unresolved* when no command is associated to it. For performance

reasons the creation of a code lens and resolving should be done in two stages.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeLens{}](#__struct__/0)

Fields

------

* range: The range in which this code lens is valid. Should only span a single line.

* command: The command this code lens represents.

* data: A data entry field that is preserved on a code lens item between

a {@link CodeLensRequest} and a [CodeLensResolveRequest]

(#CodeLensResolveRequest)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens.ex#L25 "View Source")

```

@type t() :: %GenLSP.Structures.CodeLens{

  command: [GenLSP.Structures.Command.t](GenLSP.Structures.Command.html#t:t/0)() | nil,

  data: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeLens{}

=============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens.ex#L25 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* range: The range in which this code lens is valid. Should only span a single line.

* command: The command this code lens represents.

* data: A data entry field that is preserved on a code lens item between

a {@link CodeLensRequest} and a [CodeLensResolveRequest]

(#CodeLensResolveRequest)





GenLSP.Structures.CodeLensClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.CodeLensClientCapabilities

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

The client capabilities of a {@link CodeLensRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeLensClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether code lens supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_client_capabilities.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.CodeLensClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeLensClientCapabilities{}

===============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_client_capabilities.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether code lens supports dynamic registration.





GenLSP.Structures.CodeLensOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_options.ex#L2 "View Source")

GenLSP.Structures.CodeLensOptions

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================

Code Lens provider options of a {@link CodeLensRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeLensOptions{}](#__struct__/0)

Fields

------

* resolve\_provider: Code lens has a resolve provider as well.

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.CodeLensOptions{

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeLensOptions{}

====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* resolve\_provider: Code lens has a resolve provider as well.

* work\_done\_progress





GenLSP.Structures.CodeLensParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_params.ex#L2 "View Source")

GenLSP.Structures.CodeLensParams

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================

The parameters of a {@link CodeLensRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeLensParams{}](#__struct__/0)

Fields

------

* text\_document: The document to request code lens for.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_params.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.CodeLensParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeLensParams{}

===================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_params.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document to request code lens for.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.CodeLensRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_registration_options.ex#L2 "View Source")

GenLSP.Structures.CodeLensRegistrationOptions

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================

Registration options for a {@link CodeLensRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeLensRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* resolve\_provider: Code lens has a resolve provider as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_registration_options.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.CodeLensRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeLensRegistrationOptions{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_registration_options.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* resolve\_provider: Code lens has a resolve provider as well.





GenLSP.Structures.CodeLensWorkspaceClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_workspace_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.CodeLensWorkspaceClientCapabilities

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CodeLensWorkspaceClientCapabilities{}](#__struct__/0)

Fields

------

* refresh\_support: Whether the client implementation supports a refresh request sent from the

server to the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_workspace_client_capabilities.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.CodeLensWorkspaceClientCapabilities{

  refresh_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CodeLensWorkspaceClientCapabilities{}

========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/code_lens_workspace_client_capabilities.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* refresh\_support: Whether the client implementation supports a refresh request sent from the

server to the client.

Note that this event is global and will force the client to refresh all

code lenses currently shown. It should be used with absolute care and is

useful for situation where a server for example detect a project wide

change that requires such a calculation.





GenLSP.Structures.Color — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color.ex#L2 "View Source")

GenLSP.Structures.Color

(gen\_lsp v0.6.0)

=================================================================================================================================================================================

Represents a color in RGBA space.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.Color{}](#__struct__/0)

Fields

------

* red: The red component of this color in the range [0-1].

* green: The green component of this color in the range [0-1].

* blue: The blue component of this color in the range [0-1].

* alpha: The alpha component of this color in the range [0-1].

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.Color{

  alpha: [float](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  blue: [float](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  green: [float](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  red: [float](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.Color{}

==========================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* red: The red component of this color in the range [0-1].

* green: The green component of this color in the range [0-1].

* blue: The blue component of this color in the range [0-1].

* alpha: The alpha component of this color in the range [0-1].





GenLSP.Structures.ColorInformation — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color_information.ex#L2 "View Source")

GenLSP.Structures.ColorInformation

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================

Represents a color range from a document.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ColorInformation{}](#__struct__/0)

Fields

------

* range: The range in the document where this color appears.

* color: The actual color value for this color range.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color_information.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.ColorInformation{

  color: [GenLSP.Structures.Color.t](GenLSP.Structures.Color.html#t:t/0)(),

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ColorInformation{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color_information.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* range: The range in the document where this color appears.

* color: The actual color value for this color range.





GenLSP.Structures.ColorPresentation — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color_presentation.ex#L2 "View Source")

GenLSP.Structures.ColorPresentation

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ColorPresentation{}](#__struct__/0)

Fields

------

* label: The label of this color presentation. It will be shown on the color

picker header. By default this is also the text that is inserted when selecting

this color presentation.

* text\_edit: An {@link TextEdit edit} which is applied to a document when selecting

this presentation for the color. When `falsy` the {@link ColorPresentation.label label}

is used.

* additional\_text\_edits: An optional array of additional {@link TextEdit text edits} that are applied when

selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color_presentation.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.ColorPresentation{

  additional_text_edits: [[GenLSP.Structures.TextEdit.t](GenLSP.Structures.TextEdit.html#t:t/0)()] | nil,

  label: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  text_edit: [GenLSP.Structures.TextEdit.t](GenLSP.Structures.TextEdit.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ColorPresentation{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color_presentation.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* label: The label of this color presentation. It will be shown on the color

picker header. By default this is also the text that is inserted when selecting

this color presentation.

* text\_edit: An {@link TextEdit edit} which is applied to a document when selecting

this presentation for the color. When `falsy` the {@link ColorPresentation.label label}

is used.

* additional\_text\_edits: An optional array of additional {@link TextEdit text edits} that are applied when

selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.





GenLSP.Structures.ColorPresentationParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color_presentation_params.ex#L2 "View Source")

GenLSP.Structures.ColorPresentationParams

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================

Parameters for a {@link ColorPresentationRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ColorPresentationParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* color: The color to request presentations for.

* range: The range where the color would be inserted. Serves as a context.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color_presentation_params.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.ColorPresentationParams{

  color: [GenLSP.Structures.Color.t](GenLSP.Structures.Color.html#t:t/0)(),

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ColorPresentationParams{}

============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/color_presentation_params.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* color: The color to request presentations for.

* range: The range where the color would be inserted. Serves as a context.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.Command — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/command.ex#L2 "View Source")

GenLSP.Structures.Command

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================

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.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.Command{}](#__struct__/0)

Fields

------

* title: Title of the command, like `save`.

* command: The identifier of the actual command handler.

* arguments: Arguments that the command handler should be

invoked with.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/command.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.Command{

  arguments: [[GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)()] | nil,

  command: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  title: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.Command{}

============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/command.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* title: Title of the command, like `save`.

* command: The identifier of the actual command handler.

* arguments: Arguments that the command handler should be

invoked with.





GenLSP.Structures.CompletionClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.CompletionClientCapabilities

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================================

Completion client capabilities

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CompletionClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether completion supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_client_capabilities.ex#L31 "View Source")

```

@type t() :: %GenLSP.Structures.CompletionClientCapabilities{

  completion_item: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  completion_item_kind: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  completion_list: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  context_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  insert_text_mode: [GenLSP.Enumerations.InsertTextMode.t](GenLSP.Enumerations.InsertTextMode.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CompletionClientCapabilities{}

=================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_client_capabilities.ex#L31 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether completion supports dynamic registration.

* completion\_item: The client supports the following `CompletionItem` specific

capabilities.

* completion\_item\_kind

* insert\_text\_mode: Defines how the client handles whitespace and indentation

when accepting a completion item that uses multi line

text in either `insertText` or `textEdit`.

@since 3.17.0

* context\_support: The client supports to send additional context information for a

`textDocument/completion` request.

* completion\_list: The client supports the following `CompletionList` specific

capabilities.

@since 3.17.0





GenLSP.Structures.CompletionContext — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_context.ex#L2 "View Source")

GenLSP.Structures.CompletionContext

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

Contains additional information about the context in which a completion request is triggered.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CompletionContext{}](#__struct__/0)

Fields

------

* trigger\_kind: How the completion was triggered.

* trigger\_character: The trigger character (a single character) that has trigger code complete.

Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_context.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.CompletionContext{

  trigger_character: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  trigger_kind: [GenLSP.Enumerations.CompletionTriggerKind.t](GenLSP.Enumerations.CompletionTriggerKind.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CompletionContext{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_context.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* trigger\_kind: How the completion was triggered.

* trigger\_character: The trigger character (a single character) that has trigger code complete.

Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`





GenLSP.Structures.CompletionItem — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_item.ex#L2 "View Source")

GenLSP.Structures.CompletionItem

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================

A completion item represents a text snippet that is

proposed to complete text that is being typed.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CompletionItem{}](#__struct__/0)

Fields

------

* label: The label of this completion item.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_item.ex#L115 "View Source")

```

@type t() :: %GenLSP.Structures.CompletionItem{

  additional_text_edits: [[GenLSP.Structures.TextEdit.t](GenLSP.Structures.TextEdit.html#t:t/0)()] | nil,

  command: [GenLSP.Structures.Command.t](GenLSP.Structures.Command.html#t:t/0)() | nil,

  commit_characters: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil,

  data: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  deprecated: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  detail: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  documentation: ([String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | [GenLSP.Structures.MarkupContent.t](GenLSP.Structures.MarkupContent.html#t:t/0)()) | nil,

  filter_text: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  insert_text: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  insert_text_format: [GenLSP.Enumerations.InsertTextFormat.t](GenLSP.Enumerations.InsertTextFormat.html#t:t/0)() | nil,

  insert_text_mode: [GenLSP.Enumerations.InsertTextMode.t](GenLSP.Enumerations.InsertTextMode.html#t:t/0)() | nil,

  kind: [GenLSP.Enumerations.CompletionItemKind.t](GenLSP.Enumerations.CompletionItemKind.html#t:t/0)() | nil,

  label: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  label_details: [GenLSP.Structures.CompletionItemLabelDetails.t](GenLSP.Structures.CompletionItemLabelDetails.html#t:t/0)() | nil,

  preselect: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  sort_text: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  tags: [[GenLSP.Enumerations.CompletionItemTag.t](GenLSP.Enumerations.CompletionItemTag.html#t:t/0)()] | nil,

  text_edit:

    ([GenLSP.Structures.TextEdit.t](GenLSP.Structures.TextEdit.html#t:t/0)() | [GenLSP.Structures.InsertReplaceEdit.t](GenLSP.Structures.InsertReplaceEdit.html#t:t/0)())

    | nil,

  text_edit_text: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CompletionItem{}

===================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_item.ex#L115 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* label: The label of this completion item.

The label property is also by default the text that

is inserted when selecting this completion.

If label details are provided the label itself should

be an unqualified name of the completion item.

* label\_details: Additional details for the label

@since 3.17.0

* kind: The kind of this completion item. Based of the kind

an icon is chosen by the editor.

* tags: Tags for this completion item.

@since 3.15.0

* detail: A human-readable string with additional information

about this item, like type or symbol information.

* documentation: A human-readable string that represents a doc-comment.

* deprecated: Indicates if this item is deprecated.

@deprecated Use `tags` instead.

* preselect: Select this item when showing.

*Note* that only one completion item can be selected and that the

tool / client decides which item that is. The rule is that the *first*

item of those that match best is selected.

* sort\_text: A string that should be used when comparing this item

with other items. When `falsy` the {@link CompletionItem.label label}

is used.

* filter\_text: A string that should be used when filtering a set of

completion items. When `falsy` the {@link CompletionItem.label label}

is used.

* insert\_text: A string that should be inserted into a document when selecting

this completion. When `falsy` the {@link CompletionItem.label label}

is used.

The `insertText` is subject to interpretation by the client side.

Some tools might not take the string literally. For example

VS Code when code complete is requested in this example

`con<cursor position>` and a completion item with an `insertText` of

`console` is provided it will only insert `sole`. Therefore it is

recommended to use `textEdit` instead since it avoids additional client

side interpretation.

* insert\_text\_format: The format of the insert text. The format applies to both the

`insertText` property and the `newText` property of a provided

`textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.

Please note that the insertTextFormat doesn't apply to

`additionalTextEdits`.

* insert\_text\_mode: How whitespace and indentation is handled during completion

item insertion. If not provided the clients default value depends on

the `textDocument.completion.insertTextMode` client capability.

@since 3.16.0

* text\_edit: An {@link TextEdit edit} which is applied to a document when selecting

this completion. When an edit is provided the value of

{@link CompletionItem.insertText insertText} is ignored.

Most editors support two different operations when accepting a completion

item. One is to insert a completion text and the other is to replace an

existing text with a completion text. Since this can usually not be

predetermined by a server it can report both ranges. Clients need to

signal support for `InsertReplaceEdits` via the

`textDocument.completion.insertReplaceSupport` client capability

property.

*Note 1:* The text edit's range as well as both ranges from an insert

replace edit must be a [single line] and they must contain the position

at which completion has been requested.

*Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range

must be a prefix of the edit's replace range, that means it must be

contained and starting at the same position.

@since 3.16.0 additional type `InsertReplaceEdit`

* text\_edit\_text: The edit text used if the completion item is part of a CompletionList and

CompletionList defines an item default for the text edit range.

Clients will only honor this property if they opt into completion list

item defaults using the capability `completionList.itemDefaults`.

If not provided and a list's default range is provided the label

property is used as a text.

@since 3.17.0

* additional\_text\_edits: An optional array of additional {@link TextEdit text edits} that are applied when

selecting this completion. Edits must not overlap (including the same insert position)

with the main {@link CompletionItem.textEdit edit} nor with themselves.

Additional text edits should be used to change text unrelated to the current cursor position

(for example adding an import statement at the top of the file if the completion item will

insert an unqualified type).

* commit\_characters: An optional set of characters that when pressed while this completion is active will accept it first and

then type that character. *Note* that all commit characters should have `length=1` and that superfluous

characters will be ignored.

* command: An optional {@link Command command} that is executed *after* inserting this completion. *Note* that

additional modifications to the current document should be described with the

{@link CompletionItem.additionalTextEdits additionalTextEdits}-property.

* data: A data entry field that is preserved on a completion item between a

{@link CompletionRequest} and a {@link CompletionResolveRequest}.





GenLSP.Structures.CompletionItemLabelDetails — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_item_label_details.ex#L2 "View Source")

GenLSP.Structures.CompletionItemLabelDetails

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

Additional details for a completion item label.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CompletionItemLabelDetails{}](#__struct__/0)

Fields

------

* detail: An optional string which is rendered less prominently directly after {@link CompletionItem.label label},

without any spacing. Should be used for function signatures and type annotations.

* description: An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used

for fully qualified names and file paths.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_item_label_details.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.CompletionItemLabelDetails{

  description: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  detail: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CompletionItemLabelDetails{}

===============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_item_label_details.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* detail: An optional string which is rendered less prominently directly after {@link CompletionItem.label label},

without any spacing. Should be used for function signatures and type annotations.

* description: An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used

for fully qualified names and file paths.





GenLSP.Structures.CompletionList — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_list.ex#L2 "View Source")

GenLSP.Structures.CompletionList

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================

Represents a collection of {@link CompletionItem completion items} to be presented

in the editor.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CompletionList{}](#__struct__/0)

Fields

------

* is\_incomplete: This list it not complete. Further typing results in recomputing this list.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_list.ex#L35 "View Source")

```

@type t() :: %GenLSP.Structures.CompletionList{

  is_incomplete: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)(),

  item_defaults: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  items: [[GenLSP.Structures.CompletionItem.t](GenLSP.Structures.CompletionItem.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CompletionList{}

===================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_list.ex#L35 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* is\_incomplete: This list it not complete. Further typing results in recomputing this list.

Recomputed lists have all their items replaced (not appended) in the

incomplete completion sessions.

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

If a completion list specifies a default value and a completion item

also specifies a corresponding value the one from the item is used.

Servers are only allowed to return default values if the client

signals support for this via the `completionList.itemDefaults`

capability.

@since 3.17.0

* items: The completion items.





GenLSP.Structures.CompletionOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_options.ex#L2 "View Source")

GenLSP.Structures.CompletionOptions

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

Completion options.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CompletionOptions{}](#__struct__/0)

Fields

------

* trigger\_characters: Most tools trigger completion request automatically without explicitly requesting

it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user

starts to type an identifier. For example if the user types `c` in a JavaScript file

code complete will automatically pop up present `console` besides others as a

completion item. Characters that make up identifiers don't need to be listed here.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_options.ex#L39 "View Source")

```

@type t() :: %GenLSP.Structures.CompletionOptions{

  all_commit_characters: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil,

  completion_item: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  trigger_characters: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil,

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CompletionOptions{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_options.ex#L39 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* trigger\_characters: Most tools trigger completion request automatically without explicitly requesting

it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user

starts to type an identifier. For example if the user types `c` in a JavaScript file

code complete will automatically pop up present `console` besides others as a

completion item. Characters that make up identifiers don't need to be listed here.

If code complete should automatically be trigger on characters not being valid inside

an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.

* all\_commit\_characters: The list of all possible characters that commit a completion. This field can be used

if clients don't support individual commit characters per completion item. See

`ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport`

If a server provides both `allCommitCharacters` and commit characters on an individual

completion item the ones on the completion item win.

@since 3.2.0

* resolve\_provider: The server provides support to resolve additional

information for a completion item.

* completion\_item: The server supports the following `CompletionItem` specific

capabilities.

@since 3.17.0

* work\_done\_progress





GenLSP.Structures.CompletionParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_params.ex#L2 "View Source")

GenLSP.Structures.CompletionParams

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================

Completion parameters

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CompletionParams{}](#__struct__/0)

Fields

------

* context: The completion context. This is only available it the client specifies

to send this using the client capability `textDocument.completion.contextSupport === true`

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_params.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.CompletionParams{

  context: [GenLSP.Structures.CompletionContext.t](GenLSP.Structures.CompletionContext.html#t:t/0)() | nil,

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CompletionParams{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_params.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* context: The completion context. This is only available it the client specifies

to send this using the client capability `textDocument.completion.contextSupport === true`

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.CompletionRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_registration_options.ex#L2 "View Source")

GenLSP.Structures.CompletionRegistrationOptions

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================================

Registration options for a {@link CompletionRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CompletionRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_registration_options.ex#L40 "View Source")

```

@type t() :: %GenLSP.Structures.CompletionRegistrationOptions{

  all_commit_characters: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil,

  completion_item: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  trigger_characters: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CompletionRegistrationOptions{}

==================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/completion_registration_options.ex#L40 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* trigger\_characters: Most tools trigger completion request automatically without explicitly requesting

it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user

starts to type an identifier. For example if the user types `c` in a JavaScript file

code complete will automatically pop up present `console` besides others as a

completion item. Characters that make up identifiers don't need to be listed here.

If code complete should automatically be trigger on characters not being valid inside

an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.

* all\_commit\_characters: The list of all possible characters that commit a completion. This field can be used

if clients don't support individual commit characters per completion item. See

`ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport`

If a server provides both `allCommitCharacters` and commit characters on an individual

completion item the ones on the completion item win.

@since 3.2.0

* resolve\_provider: The server provides support to resolve additional

information for a completion item.

* completion\_item: The server supports the following `CompletionItem` specific

capabilities.

@since 3.17.0





GenLSP.Structures.ConfigurationItem — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/configuration_item.ex#L2 "View Source")

GenLSP.Structures.ConfigurationItem

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ConfigurationItem{}](#__struct__/0)

Fields

------

* scope\_uri: The scope to get the configuration section for.

* section: The configuration section asked for.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/configuration_item.ex#L14 "View Source")

```

@type t() :: %GenLSP.Structures.ConfigurationItem{

  scope_uri: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  section: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ConfigurationItem{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/configuration_item.ex#L14 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* scope\_uri: The scope to get the configuration section for.

* section: The configuration section asked for.





GenLSP.Structures.ConfigurationParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/configuration_params.ex#L2 "View Source")

GenLSP.Structures.ConfigurationParams

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================

The parameters of a configuration request.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ConfigurationParams{}](#__struct__/0)

Fields

------

* items

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/configuration_params.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.ConfigurationParams{

  items: [[GenLSP.Structures.ConfigurationItem.t](GenLSP.Structures.ConfigurationItem.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ConfigurationParams{}

========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/configuration_params.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* items





GenLSP.Structures.CreateFile — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/create_file.ex#L2 "View Source")

GenLSP.Structures.CreateFile

(gen\_lsp v0.6.0)

============================================================================================================================================================================================

Create file operation.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CreateFile{}](#__struct__/0)

Fields

------

* kind: A create

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/create_file.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.CreateFile{

  annotation_id: [GenLSP.TypeAlias.ChangeAnnotationIdentifier.t](GenLSP.TypeAlias.ChangeAnnotationIdentifier.html#t:t/0)() | nil,

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  options: [GenLSP.Structures.CreateFileOptions.t](GenLSP.Structures.CreateFileOptions.html#t:t/0)() | nil,

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CreateFile{}

===============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/create_file.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* kind: A create

* uri: The resource to create.

* options: Additional options

* annotation\_id: An optional annotation identifier describing the operation.

@since 3.16.0





GenLSP.Structures.CreateFileOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/create_file_options.ex#L2 "View Source")

GenLSP.Structures.CreateFileOptions

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

Options to create a file.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CreateFileOptions{}](#__struct__/0)

Fields

------

* overwrite: Overwrite existing file. Overwrite wins over `ignoreIfExists`

* ignore\_if\_exists: Ignore if exists.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/create_file_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.CreateFileOptions{

  ignore_if_exists: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  overwrite: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CreateFileOptions{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/create_file_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* overwrite: Overwrite existing file. Overwrite wins over `ignoreIfExists`

* ignore\_if\_exists: Ignore if exists.





GenLSP.Structures.CreateFilesParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/create_files_params.ex#L2 "View Source")

GenLSP.Structures.CreateFilesParams

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

The parameters sent in notifications/requests for user-initiated creation of

files.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.CreateFilesParams{}](#__struct__/0)

Fields

------

* files: An array of all files/folders created in this operation.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/create_files_params.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.CreateFilesParams{

  files: [[GenLSP.Structures.FileCreate.t](GenLSP.Structures.FileCreate.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.CreateFilesParams{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/create_files_params.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* files: An array of all files/folders created in this operation.





GenLSP.Structures.DeclarationClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DeclarationClientCapabilities

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================================

@since 3.14.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DeclarationClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether declaration supports dynamic registration. If this is set to `true`

the client supports the new `DeclarationRegistrationOptions` return value

for the corresponding server capability as well.

* link\_support: The client supports additional metadata in the form of declaration links.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_client_capabilities.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.DeclarationClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  link_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DeclarationClientCapabilities{}

==================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_client_capabilities.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether declaration supports dynamic registration. If this is set to `true`

the client supports the new `DeclarationRegistrationOptions` return value

for the corresponding server capability as well.

* link\_support: The client supports additional metadata in the form of declaration links.





GenLSP.Structures.DeclarationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_options.ex#L2 "View Source")

GenLSP.Structures.DeclarationOptions

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DeclarationOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_options.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.DeclarationOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DeclarationOptions{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_options.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.DeclarationParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_params.ex#L2 "View Source")

GenLSP.Structures.DeclarationParams

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DeclarationParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_params.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DeclarationParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DeclarationParams{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_params.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.DeclarationRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_registration_options.ex#L2 "View Source")

GenLSP.Structures.DeclarationRegistrationOptions

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DeclarationRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_registration_options.ex#L16 "View Source")

```

@type t() :: %GenLSP.Structures.DeclarationRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DeclarationRegistrationOptions{}

===================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/declaration_registration_options.ex#L16 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.DefinitionClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DefinitionClientCapabilities

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================================

Client Capabilities for a {@link DefinitionRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DefinitionClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether definition supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_client_capabilities.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.DefinitionClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  link_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DefinitionClientCapabilities{}

=================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_client_capabilities.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether definition supports dynamic registration.

* link\_support: The client supports additional metadata in the form of definition links.

@since 3.14.0





GenLSP.Structures.DefinitionOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_options.ex#L2 "View Source")

GenLSP.Structures.DefinitionOptions

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

Server Capabilities for a {@link DefinitionRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DefinitionOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_options.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DefinitionOptions{work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DefinitionOptions{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_options.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.DefinitionParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_params.ex#L2 "View Source")

GenLSP.Structures.DefinitionParams

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================

Parameters for a {@link DefinitionRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DefinitionParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.DefinitionParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DefinitionParams{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.DefinitionRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_registration_options.ex#L2 "View Source")

GenLSP.Structures.DefinitionRegistrationOptions

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================================

Registration options for a {@link DefinitionRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DefinitionRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_registration_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.DefinitionRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DefinitionRegistrationOptions{}

==================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/definition_registration_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.DeleteFile — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/delete_file.ex#L2 "View Source")

GenLSP.Structures.DeleteFile

(gen\_lsp v0.6.0)

============================================================================================================================================================================================

Delete file operation

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DeleteFile{}](#__struct__/0)

Fields

------

* kind: A delete

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/delete_file.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.DeleteFile{

  annotation_id: [GenLSP.TypeAlias.ChangeAnnotationIdentifier.t](GenLSP.TypeAlias.ChangeAnnotationIdentifier.html#t:t/0)() | nil,

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  options: [GenLSP.Structures.DeleteFileOptions.t](GenLSP.Structures.DeleteFileOptions.html#t:t/0)() | nil,

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DeleteFile{}

===============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/delete_file.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* kind: A delete

* uri: The file to delete.

* options: Delete options.

* annotation\_id: An optional annotation identifier describing the operation.

@since 3.16.0





GenLSP.Structures.DeleteFileOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/delete_file_options.ex#L2 "View Source")

GenLSP.Structures.DeleteFileOptions

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

Delete file options

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DeleteFileOptions{}](#__struct__/0)

Fields

------

* recursive: Delete the content recursively if a folder is denoted.

* ignore\_if\_not\_exists: Ignore the operation if the file doesn't exist.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/delete_file_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.DeleteFileOptions{

  ignore_if_not_exists: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  recursive: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DeleteFileOptions{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/delete_file_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* recursive: Delete the content recursively if a folder is denoted.

* ignore\_if\_not\_exists: Ignore the operation if the file doesn't exist.





GenLSP.Structures.DeleteFilesParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/delete_files_params.ex#L2 "View Source")

GenLSP.Structures.DeleteFilesParams

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

The parameters sent in notifications/requests for user-initiated deletes of

files.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DeleteFilesParams{}](#__struct__/0)

Fields

------

* files: An array of all files/folders deleted in this operation.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/delete_files_params.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.DeleteFilesParams{

  files: [[GenLSP.Structures.FileDelete.t](GenLSP.Structures.FileDelete.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DeleteFilesParams{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/delete_files_params.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* files: An array of all files/folders deleted in this operation.





GenLSP.Structures.Diagnostic — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic.ex#L2 "View Source")

GenLSP.Structures.Diagnostic

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================

Represents a diagnostic, such as a compiler error or warning. Diagnostic objects

are only valid in the scope of a resource.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.Diagnostic{}](#__struct__/0)

Fields

------

* range: The range at which the message applies

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic.ex#L38 "View Source")

```

@type t() :: %GenLSP.Structures.Diagnostic{

  code: ([integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()) | nil,

  code_description: [GenLSP.Structures.CodeDescription.t](GenLSP.Structures.CodeDescription.html#t:t/0)() | nil,

  data: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  message: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  related_information:

    [[GenLSP.Structures.DiagnosticRelatedInformation.t](GenLSP.Structures.DiagnosticRelatedInformation.html#t:t/0)()] | nil,

  severity: [GenLSP.Enumerations.DiagnosticSeverity.t](GenLSP.Enumerations.DiagnosticSeverity.html#t:t/0)() | nil,

  source: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  tags: [[GenLSP.Enumerations.DiagnosticTag.t](GenLSP.Enumerations.DiagnosticTag.html#t:t/0)()] | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.Diagnostic{}

===============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic.ex#L38 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* range: The range at which the message applies

* severity: The diagnostic's severity. Can be omitted. If omitted it is up to the

client to interpret diagnostics as error, warning, info or hint.

* code: The diagnostic's code, which usually appear in the user interface.

* code\_description: An optional property to describe the error code.

Requires the code field (above) to be present/not null.

@since 3.16.0

* source: A human-readable string describing the source of this

diagnostic, e.g. 'typescript' or 'super lint'. It usually

appears in the user interface.

* message: The diagnostic's message. It usually appears in the user interface

* tags: Additional metadata about the diagnostic.

@since 3.15.0

* related\_information: An array of related diagnostic information, e.g. when symbol-names within

a scope collide all definitions can be marked via this property.

* data: A data entry field that is preserved between a `textDocument/publishDiagnostics`

notification and `textDocument/codeAction` request.

@since 3.16.0





GenLSP.Structures.DiagnosticClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DiagnosticClientCapabilities

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================================

Client capabilities specific to diagnostic pull requests.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DiagnosticClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.

* related\_document\_support: Whether the clients supports related documents for document diagnostic pulls.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_client_capabilities.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.DiagnosticClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  related_document_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DiagnosticClientCapabilities{}

=================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_client_capabilities.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.

* related\_document\_support: Whether the clients supports related documents for document diagnostic pulls.





GenLSP.Structures.DiagnosticOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_options.ex#L2 "View Source")

GenLSP.Structures.DiagnosticOptions

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

Diagnostic options.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DiagnosticOptions{}](#__struct__/0)

Fields

------

* identifier: An optional identifier under which the diagnostics are

managed by the client.

* inter\_file\_dependencies: Whether the language has inter file dependencies meaning that

editing code in one file can result in a different diagnostic

set in another file. Inter file dependencies are common for

most programming languages and typically uncommon for linters.

* workspace\_diagnostics: The server provides support for workspace diagnostics as well.

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_options.ex#L26 "View Source")

```

@type t() :: %GenLSP.Structures.DiagnosticOptions{

  identifier: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  inter_file_dependencies: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)(),

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  workspace_diagnostics: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DiagnosticOptions{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_options.ex#L26 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* identifier: An optional identifier under which the diagnostics are

managed by the client.

* inter\_file\_dependencies: Whether the language has inter file dependencies meaning that

editing code in one file can result in a different diagnostic

set in another file. Inter file dependencies are common for

most programming languages and typically uncommon for linters.

* workspace\_diagnostics: The server provides support for workspace diagnostics as well.

* work\_done\_progress





GenLSP.Structures.DiagnosticRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_registration_options.ex#L2 "View Source")

GenLSP.Structures.DiagnosticRegistrationOptions

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================================

Diagnostic registration options.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DiagnosticRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* identifier: An optional identifier under which the diagnostics are

managed by the client.

* inter\_file\_dependencies: Whether the language has inter file dependencies meaning that

editing code in one file can result in a different diagnostic

set in another file. Inter file dependencies are common for

most programming languages and typically uncommon for linters.

* workspace\_diagnostics: The server provides support for workspace diagnostics as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_registration_options.ex#L29 "View Source")

```

@type t() :: %GenLSP.Structures.DiagnosticRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  identifier: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  inter_file_dependencies: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)(),

  workspace_diagnostics: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DiagnosticRegistrationOptions{}

==================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_registration_options.ex#L29 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* identifier: An optional identifier under which the diagnostics are

managed by the client.

* inter\_file\_dependencies: Whether the language has inter file dependencies meaning that

editing code in one file can result in a different diagnostic

set in another file. Inter file dependencies are common for

most programming languages and typically uncommon for linters.

* workspace\_diagnostics: The server provides support for workspace diagnostics as well.





GenLSP.Structures.DiagnosticRelatedInformation — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_related_information.ex#L2 "View Source")

GenLSP.Structures.DiagnosticRelatedInformation

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================================

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.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DiagnosticRelatedInformation{}](#__struct__/0)

Fields

------

* location: The location of this related diagnostic information.

* message: The message of this related diagnostic information.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_related_information.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.DiagnosticRelatedInformation{

  location: [GenLSP.Structures.Location.t](GenLSP.Structures.Location.html#t:t/0)(),

  message: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DiagnosticRelatedInformation{}

=================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_related_information.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* location: The location of this related diagnostic information.

* message: The message of this related diagnostic information.





GenLSP.Structures.DiagnosticServerCancellationData — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_server_cancellation_data.ex#L2 "View Source")

GenLSP.Structures.DiagnosticServerCancellationData

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

Cancellation data returned from a diagnostic request.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DiagnosticServerCancellationData{}](#__struct__/0)

Fields

------

* retrigger\_request

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_server_cancellation_data.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.DiagnosticServerCancellationData{

  retrigger_request: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DiagnosticServerCancellationData{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_server_cancellation_data.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* retrigger\_request





GenLSP.Structures.DiagnosticWorkspaceClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_workspace_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DiagnosticWorkspaceClientCapabilities

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================================================================

Workspace client capabilities specific to diagnostic pull requests.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DiagnosticWorkspaceClientCapabilities{}](#__struct__/0)

Fields

------

* refresh\_support: Whether the client implementation supports a refresh request sent from

the server to the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_workspace_client_capabilities.ex#L25 "View Source")

```

@type t() :: %GenLSP.Structures.DiagnosticWorkspaceClientCapabilities{

  refresh_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DiagnosticWorkspaceClientCapabilities{}

==========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/diagnostic_workspace_client_capabilities.ex#L25 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* refresh\_support: Whether the client implementation supports a refresh request sent from

the server to the client.

Note that this event is global and will force the client to refresh all

pulled diagnostics currently shown. It should be used with absolute care and

is useful for situation where a server for example detects a project wide

change that requires such a calculation.





GenLSP.Structures.DidChangeConfigurationClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_configuration_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DidChangeConfigurationClientCapabilities

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidChangeConfigurationClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Did change configuration notification supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_configuration_client_capabilities.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.DidChangeConfigurationClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidChangeConfigurationClientCapabilities{}

=============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_configuration_client_capabilities.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Did change configuration notification supports dynamic registration.





GenLSP.Structures.DidChangeConfigurationParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_configuration_params.ex#L2 "View Source")

GenLSP.Structures.DidChangeConfigurationParams

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================

The parameters of a change configuration notification.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidChangeConfigurationParams{}](#__struct__/0)

Fields

------

* settings: The actual changed settings

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_configuration_params.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DidChangeConfigurationParams{

  settings: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidChangeConfigurationParams{}

=================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_configuration_params.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* settings: The actual changed settings





GenLSP.Structures.DidChangeConfigurationRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_configuration_registration_options.ex#L2 "View Source")

GenLSP.Structures.DidChangeConfigurationRegistrationOptions

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidChangeConfigurationRegistrationOptions{}](#__struct__/0)

Fields

------

* section

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_configuration_registration_options.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.DidChangeConfigurationRegistrationOptions{

  section: ([String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()]) | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidChangeConfigurationRegistrationOptions{}

==============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_configuration_registration_options.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* section





GenLSP.Structures.DidChangeNotebookDocumentParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_notebook_document_params.ex#L2 "View Source")

GenLSP.Structures.DidChangeNotebookDocumentParams

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================================

The params sent in a change notebook document notification.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidChangeNotebookDocumentParams{}](#__struct__/0)

Fields

------

* notebook\_document: The notebook document that did change. The version number points

to the version after all provided changes have been applied. If

only the text document content of a cell changes the notebook version

doesn't necessarily have to change.

* change: The actual changes to the notebook document.The changes describe single state changes to the notebook document.

So if there are two changes c1 (at array index 0) and c2 (at array

index 1) for a notebook in state S then c1 moves the notebook from

S to S' and c2 from S' to S''. So c1 is computed on the state S and

c2 is computed on the state S'.To mirror the content of a notebook using change events use the following approach:

	+ start with the same initial content

	+ apply the 'notebookDocument/didChange' notifications in the order you receive them.

	+ apply the `NotebookChangeEvent`s in a single notification in the order

	you receive them.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_notebook_document_params.ex#L35 "View Source")

```

@type t() :: %GenLSP.Structures.DidChangeNotebookDocumentParams{

  change: [GenLSP.Structures.NotebookDocumentChangeEvent.t](GenLSP.Structures.NotebookDocumentChangeEvent.html#t:t/0)(),

  notebook_document: [GenLSP.Structures.VersionedNotebookDocumentIdentifier.t](GenLSP.Structures.VersionedNotebookDocumentIdentifier.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidChangeNotebookDocumentParams{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_notebook_document_params.ex#L35 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* notebook\_document: The notebook document that did change. The version number points

to the version after all provided changes have been applied. If

only the text document content of a cell changes the notebook version

doesn't necessarily have to change.

* change: The actual changes to the notebook document.The changes describe single state changes to the notebook document.

So if there are two changes c1 (at array index 0) and c2 (at array

index 1) for a notebook in state S then c1 moves the notebook from

S to S' and c2 from S' to S''. So c1 is computed on the state S and

c2 is computed on the state S'.To mirror the content of a notebook using change events use the following approach:

	+ start with the same initial content

	+ apply the 'notebookDocument/didChange' notifications in the order you receive them.

	+ apply the `NotebookChangeEvent`s in a single notification in the order

	you receive them.





GenLSP.Structures.DidChangeTextDocumentParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_text_document_params.ex#L2 "View Source")

GenLSP.Structures.DidChangeTextDocumentParams

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================================

The change text document notification's parameters.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidChangeTextDocumentParams{}](#__struct__/0)

Fields

------

* text\_document: The document that did change. The version number points

to the version after all provided content changes have

been applied.

* content\_changes: The actual content changes. The content changes describe single state changes

to the document. So if there are two content changes c1 (at array index 0) and

c2 (at array index 1) for a document in state S then c1 moves the document from

S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed

on the state S'.To mirror the content of a document using change events use the following approach:

	+ start with the same initial content

	+ apply the 'textDocument/didChange' notifications in the order you receive them.

	+ apply the `TextDocumentContentChangeEvent`s in a single notification in the order

	you receive them.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_text_document_params.ex#L30 "View Source")

```

@type t() :: %GenLSP.Structures.DidChangeTextDocumentParams{

  content_changes: [[GenLSP.TypeAlias.TextDocumentContentChangeEvent.t](GenLSP.TypeAlias.TextDocumentContentChangeEvent.html#t:t/0)()],

  text_document: [GenLSP.Structures.VersionedTextDocumentIdentifier.t](GenLSP.Structures.VersionedTextDocumentIdentifier.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidChangeTextDocumentParams{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_text_document_params.ex#L30 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document that did change. The version number points

to the version after all provided content changes have

been applied.

* content\_changes: The actual content changes. The content changes describe single state changes

to the document. So if there are two content changes c1 (at array index 0) and

c2 (at array index 1) for a document in state S then c1 moves the document from

S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed

on the state S'.To mirror the content of a document using change events use the following approach:

	+ start with the same initial content

	+ apply the 'textDocument/didChange' notifications in the order you receive them.

	+ apply the `TextDocumentContentChangeEvent`s in a single notification in the order

	you receive them.





GenLSP.Structures.DidChangeWatchedFilesClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_watched_files_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DidChangeWatchedFilesClientCapabilities

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidChangeWatchedFilesClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Did change watched files notification supports dynamic registration. Please note

that the current protocol doesn't support static configuration for file changes

from the server side.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_watched_files_client_capabilities.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.DidChangeWatchedFilesClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  relative_pattern_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidChangeWatchedFilesClientCapabilities{}

============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_watched_files_client_capabilities.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Did change watched files notification supports dynamic registration. Please note

that the current protocol doesn't support static configuration for file changes

from the server side.

* relative\_pattern\_support: Whether the client has support for {@link RelativePattern relative pattern}

or not.

@since 3.17.0





GenLSP.Structures.DidChangeWatchedFilesParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_watched_files_params.ex#L2 "View Source")

GenLSP.Structures.DidChangeWatchedFilesParams

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================================

The watched files change notification's parameters.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidChangeWatchedFilesParams{}](#__struct__/0)

Fields

------

* changes: The actual file events.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_watched_files_params.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DidChangeWatchedFilesParams{

  changes: [[GenLSP.Structures.FileEvent.t](GenLSP.Structures.FileEvent.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidChangeWatchedFilesParams{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_watched_files_params.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* changes: The actual file events.





GenLSP.Structures.DidChangeWatchedFilesRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_watched_files_registration_options.ex#L2 "View Source")

GenLSP.Structures.DidChangeWatchedFilesRegistrationOptions

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================================================

Describe options to be used when registered for text document change events.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidChangeWatchedFilesRegistrationOptions{}](#__struct__/0)

Fields

------

* watchers: The watchers to register.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_watched_files_registration_options.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DidChangeWatchedFilesRegistrationOptions{

  watchers: [[GenLSP.Structures.FileSystemWatcher.t](GenLSP.Structures.FileSystemWatcher.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidChangeWatchedFilesRegistrationOptions{}

=============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_watched_files_registration_options.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* watchers: The watchers to register.





GenLSP.Structures.DidChangeWorkspaceFoldersParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_workspace_folders_params.ex#L2 "View Source")

GenLSP.Structures.DidChangeWorkspaceFoldersParams

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================================

The parameters of a `workspace/didChangeWorkspaceFolders` notification.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidChangeWorkspaceFoldersParams{}](#__struct__/0)

Fields

------

* event: The actual workspace folder change event.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_workspace_folders_params.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DidChangeWorkspaceFoldersParams{

  event: [GenLSP.Structures.WorkspaceFoldersChangeEvent.t](GenLSP.Structures.WorkspaceFoldersChangeEvent.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidChangeWorkspaceFoldersParams{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_change_workspace_folders_params.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* event: The actual workspace folder change event.





GenLSP.Structures.DidCloseNotebookDocumentParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_close_notebook_document_params.ex#L2 "View Source")

GenLSP.Structures.DidCloseNotebookDocumentParams

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================================

The params sent in a close notebook document notification.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidCloseNotebookDocumentParams{}](#__struct__/0)

Fields

------

* notebook\_document: The notebook document that got closed.

* cell\_text\_documents: The text documents that represent the content

of a notebook cell that got closed.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_close_notebook_document_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.DidCloseNotebookDocumentParams{

  cell_text_documents: [[GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)()],

  notebook_document: [GenLSP.Structures.NotebookDocumentIdentifier.t](GenLSP.Structures.NotebookDocumentIdentifier.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidCloseNotebookDocumentParams{}

===================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_close_notebook_document_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* notebook\_document: The notebook document that got closed.

* cell\_text\_documents: The text documents that represent the content

of a notebook cell that got closed.





GenLSP.Structures.DidCloseTextDocumentParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_close_text_document_params.ex#L2 "View Source")

GenLSP.Structures.DidCloseTextDocumentParams

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================================

The parameters sent in a close text document notification

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidCloseTextDocumentParams{}](#__struct__/0)

Fields

------

* text\_document: The document that was closed.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_close_text_document_params.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DidCloseTextDocumentParams{

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidCloseTextDocumentParams{}

===============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_close_text_document_params.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document that was closed.





GenLSP.Structures.DidOpenNotebookDocumentParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_open_notebook_document_params.ex#L2 "View Source")

GenLSP.Structures.DidOpenNotebookDocumentParams

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================================

The params sent in an open notebook document notification.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidOpenNotebookDocumentParams{}](#__struct__/0)

Fields

------

* notebook\_document: The notebook document that got opened.

* cell\_text\_documents: The text documents that represent the content

of a notebook cell.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_open_notebook_document_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.DidOpenNotebookDocumentParams{

  cell_text_documents: [[GenLSP.Structures.TextDocumentItem.t](GenLSP.Structures.TextDocumentItem.html#t:t/0)()],

  notebook_document: [GenLSP.Structures.NotebookDocument.t](GenLSP.Structures.NotebookDocument.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidOpenNotebookDocumentParams{}

==================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_open_notebook_document_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* notebook\_document: The notebook document that got opened.

* cell\_text\_documents: The text documents that represent the content

of a notebook cell.





GenLSP.Structures.DidOpenTextDocumentParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_open_text_document_params.ex#L2 "View Source")

GenLSP.Structures.DidOpenTextDocumentParams

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================================

The parameters sent in an open text document notification

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidOpenTextDocumentParams{}](#__struct__/0)

Fields

------

* text\_document: The document that was opened.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_open_text_document_params.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DidOpenTextDocumentParams{

  text_document: [GenLSP.Structures.TextDocumentItem.t](GenLSP.Structures.TextDocumentItem.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidOpenTextDocumentParams{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_open_text_document_params.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document that was opened.





GenLSP.Structures.DidSaveNotebookDocumentParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_save_notebook_document_params.ex#L2 "View Source")

GenLSP.Structures.DidSaveNotebookDocumentParams

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================================

The params sent in a save notebook document notification.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidSaveNotebookDocumentParams{}](#__struct__/0)

Fields

------

* notebook\_document: The notebook document that got saved.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_save_notebook_document_params.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.DidSaveNotebookDocumentParams{

  notebook_document: [GenLSP.Structures.NotebookDocumentIdentifier.t](GenLSP.Structures.NotebookDocumentIdentifier.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidSaveNotebookDocumentParams{}

==================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_save_notebook_document_params.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* notebook\_document: The notebook document that got saved.





GenLSP.Structures.DidSaveTextDocumentParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_save_text_document_params.ex#L2 "View Source")

GenLSP.Structures.DidSaveTextDocumentParams

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================================

The parameters sent in a save text document notification

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DidSaveTextDocumentParams{}](#__struct__/0)

Fields

------

* text\_document: The document that was saved.

* text: Optional the content when saved. Depends on the includeText value

when the save notification was requested.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_save_text_document_params.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.DidSaveTextDocumentParams{

  text: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DidSaveTextDocumentParams{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/did_save_text_document_params.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document that was saved.

* text: Optional the content when saved. Depends on the includeText value

when the save notification was requested.





GenLSP.Structures.DocumentColorClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DocumentColorClientCapabilities

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentColorClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `DocumentColorRegistrationOptions` return value

for the corresponding server capability as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_client_capabilities.ex#L15 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentColorClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentColorClientCapabilities{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_client_capabilities.ex#L15 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `DocumentColorRegistrationOptions` return value

for the corresponding server capability as well.





GenLSP.Structures.DocumentColorOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_options.ex#L2 "View Source")

GenLSP.Structures.DocumentColorOptions

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentColorOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_options.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentColorOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentColorOptions{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_options.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.DocumentColorParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_params.ex#L2 "View Source")

GenLSP.Structures.DocumentColorParams

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

Parameters for a {@link DocumentColorRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentColorParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_params.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentColorParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentColorParams{}

========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_params.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.DocumentColorRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_registration_options.ex#L2 "View Source")

GenLSP.Structures.DocumentColorRegistrationOptions

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentColorRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_registration_options.ex#L16 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentColorRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentColorRegistrationOptions{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_color_registration_options.ex#L16 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.DocumentDiagnosticParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_diagnostic_params.ex#L2 "View Source")

GenLSP.Structures.DocumentDiagnosticParams

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================

Parameters of the document diagnostic request.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentDiagnosticParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* identifier: The additional identifier provided during registration.

* previous\_result\_id: The result id of a previous response if provided.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_diagnostic_params.ex#L24 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentDiagnosticParams{

  identifier: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  previous_result_id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentDiagnosticParams{}

=============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_diagnostic_params.ex#L24 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* identifier: The additional identifier provided during registration.

* previous\_result\_id: The result id of a previous response if provided.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.DocumentDiagnosticReportPartialResult — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_diagnostic_report_partial_result.ex#L2 "View Source")

GenLSP.Structures.DocumentDiagnosticReportPartialResult

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================================================

A partial result for a document diagnostic report.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentDiagnosticReportPartialResult{}](#__struct__/0)

Fields

------

* related\_documents

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_diagnostic_report_partial_result.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentDiagnosticReportPartialResult{

  related_documents: %{

    required([GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()) =>

      [GenLSP.Structures.FullDocumentDiagnosticReport.t](GenLSP.Structures.FullDocumentDiagnosticReport.html#t:t/0)()

      | [GenLSP.Structures.UnchangedDocumentDiagnosticReport.t](GenLSP.Structures.UnchangedDocumentDiagnosticReport.html#t:t/0)()

  }

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentDiagnosticReportPartialResult{}

==========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_diagnostic_report_partial_result.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* related\_documents





GenLSP.Structures.DocumentFormattingClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DocumentFormattingClientCapabilities

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================================

Client capabilities of a {@link DocumentFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentFormattingClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether formatting supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_client_capabilities.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentFormattingClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentFormattingClientCapabilities{}

=========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_client_capabilities.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether formatting supports dynamic registration.





GenLSP.Structures.DocumentFormattingOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_options.ex#L2 "View Source")

GenLSP.Structures.DocumentFormattingOptions

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================

Provider options for a {@link DocumentFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentFormattingOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_options.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentFormattingOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentFormattingOptions{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_options.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.DocumentFormattingParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_params.ex#L2 "View Source")

GenLSP.Structures.DocumentFormattingParams

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================

The parameters of a {@link DocumentFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentFormattingParams{}](#__struct__/0)

Fields

------

* text\_document: The document to format.

* options: The format options.

* work\_done\_token: An optional token that a server can use to report work done progress.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_params.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentFormattingParams{

  options: [GenLSP.Structures.FormattingOptions.t](GenLSP.Structures.FormattingOptions.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentFormattingParams{}

=============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_params.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document to format.

* options: The format options.

* work\_done\_token: An optional token that a server can use to report work done progress.





GenLSP.Structures.DocumentFormattingRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_registration_options.ex#L2 "View Source")

GenLSP.Structures.DocumentFormattingRegistrationOptions

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================================================================

Registration options for a {@link DocumentFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentFormattingRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_registration_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentFormattingRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentFormattingRegistrationOptions{}

==========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_formatting_registration_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.DocumentHighlight — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight.ex#L2 "View Source")

GenLSP.Structures.DocumentHighlight

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

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.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentHighlight{}](#__struct__/0)

Fields

------

* range: The range this highlight applies to.

* kind: The highlight kind, default is {@link DocumentHighlightKind.Text text}.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentHighlight{

  kind: [GenLSP.Enumerations.DocumentHighlightKind.t](GenLSP.Enumerations.DocumentHighlightKind.html#t:t/0)() | nil,

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentHighlight{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* range: The range this highlight applies to.

* kind: The highlight kind, default is {@link DocumentHighlightKind.Text text}.





GenLSP.Structures.DocumentHighlightClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DocumentHighlightClientCapabilities

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================================

Client Capabilities for a {@link DocumentHighlightRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentHighlightClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether document highlight supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_client_capabilities.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentHighlightClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentHighlightClientCapabilities{}

========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_client_capabilities.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether document highlight supports dynamic registration.





GenLSP.Structures.DocumentHighlightOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_options.ex#L2 "View Source")

GenLSP.Structures.DocumentHighlightOptions

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================

Provider options for a {@link DocumentHighlightRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentHighlightOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_options.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentHighlightOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentHighlightOptions{}

=============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_options.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.DocumentHighlightParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_params.ex#L2 "View Source")

GenLSP.Structures.DocumentHighlightParams

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================

Parameters for a {@link DocumentHighlightRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentHighlightParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentHighlightParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentHighlightParams{}

============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.DocumentHighlightRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_registration_options.ex#L2 "View Source")

GenLSP.Structures.DocumentHighlightRegistrationOptions

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================================

Registration options for a {@link DocumentHighlightRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentHighlightRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_registration_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentHighlightRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentHighlightRegistrationOptions{}

=========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_highlight_registration_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.DocumentLink — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link.ex#L2 "View Source")

GenLSP.Structures.DocumentLink

(gen\_lsp v0.6.0)

================================================================================================================================================================================================

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.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentLink{}](#__struct__/0)

Fields

------

* range: The range this link applies to.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link.ex#L28 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentLink{

  data: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  target: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  tooltip: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentLink{}

=================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link.ex#L28 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* range: The range this link applies to.

* target: The uri this link points to. If missing a resolve request is sent later.

* tooltip: The tooltip text when you hover over this link.

If a tooltip is provided, is will be displayed in a string that includes instructions on how to

trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,

user settings, and localization.

@since 3.15.0

* data: A data entry field that is preserved on a document link between a

DocumentLinkRequest and a DocumentLinkResolveRequest.





GenLSP.Structures.DocumentLinkClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DocumentLinkClientCapabilities

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================================

The client capabilities of a {@link DocumentLinkRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentLinkClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether document link supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_client_capabilities.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentLinkClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  tooltip_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentLinkClientCapabilities{}

===================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_client_capabilities.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether document link supports dynamic registration.

* tooltip\_support: Whether the client supports the `tooltip` property on `DocumentLink`.

@since 3.15.0





GenLSP.Structures.DocumentLinkOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_options.ex#L2 "View Source")

GenLSP.Structures.DocumentLinkOptions

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

Provider options for a {@link DocumentLinkRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentLinkOptions{}](#__struct__/0)

Fields

------

* resolve\_provider: Document links have a resolve provider as well.

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentLinkOptions{

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentLinkOptions{}

========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* resolve\_provider: Document links have a resolve provider as well.

* work\_done\_progress





GenLSP.Structures.DocumentLinkParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_params.ex#L2 "View Source")

GenLSP.Structures.DocumentLinkParams

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================

The parameters of a {@link DocumentLinkRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentLinkParams{}](#__struct__/0)

Fields

------

* text\_document: The document to provide document links for.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_params.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentLinkParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentLinkParams{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_params.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document to provide document links for.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.DocumentLinkRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_registration_options.ex#L2 "View Source")

GenLSP.Structures.DocumentLinkRegistrationOptions

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

Registration options for a {@link DocumentLinkRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentLinkRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* resolve\_provider: Document links have a resolve provider as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_registration_options.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentLinkRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentLinkRegistrationOptions{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_link_registration_options.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* resolve\_provider: Document links have a resolve provider as well.





GenLSP.Structures.DocumentOnTypeFormattingClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DocumentOnTypeFormattingClientCapabilities

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================================================

Client capabilities of a {@link DocumentOnTypeFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentOnTypeFormattingClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether on type formatting supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_client_capabilities.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentOnTypeFormattingClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentOnTypeFormattingClientCapabilities{}

===============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_client_capabilities.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether on type formatting supports dynamic registration.





GenLSP.Structures.DocumentOnTypeFormattingOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_options.ex#L2 "View Source")

GenLSP.Structures.DocumentOnTypeFormattingOptions

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================================

Provider options for a {@link DocumentOnTypeFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentOnTypeFormattingOptions{}](#__struct__/0)

Fields

------

* first\_trigger\_character: A character on which formatting should be triggered, like `{`.

* more\_trigger\_character: More trigger characters.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentOnTypeFormattingOptions{

  first_trigger_character: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  more_trigger_character: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentOnTypeFormattingOptions{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* first\_trigger\_character: A character on which formatting should be triggered, like `{`.

* more\_trigger\_character: More trigger characters.





GenLSP.Structures.DocumentOnTypeFormattingParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_params.ex#L2 "View Source")

GenLSP.Structures.DocumentOnTypeFormattingParams

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================================

The parameters of a {@link DocumentOnTypeFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentOnTypeFormattingParams{}](#__struct__/0)

Fields

------

* text\_document: The document to format.

* position: The position around which the on type formatting should happen.

This is not necessarily the exact position where the character denoted

by the property `ch` got typed.

* ch: The character that has been typed that triggered the formatting

on type request. That is not necessarily the last character that

got inserted into the document since the client could auto insert

characters as well (e.g. like automatic brace completion).

* options: The formatting options.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_params.ex#L25 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentOnTypeFormattingParams{

  ch: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  options: [GenLSP.Structures.FormattingOptions.t](GenLSP.Structures.FormattingOptions.html#t:t/0)(),

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentOnTypeFormattingParams{}

===================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_params.ex#L25 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document to format.

* position: The position around which the on type formatting should happen.

This is not necessarily the exact position where the character denoted

by the property `ch` got typed.

* ch: The character that has been typed that triggered the formatting

on type request. That is not necessarily the last character that

got inserted into the document since the client could auto insert

characters as well (e.g. like automatic brace completion).

* options: The formatting options.





GenLSP.Structures.DocumentOnTypeFormattingRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_registration_options.ex#L2 "View Source")

GenLSP.Structures.DocumentOnTypeFormattingRegistrationOptions

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================================================

Registration options for a {@link DocumentOnTypeFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentOnTypeFormattingRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* first\_trigger\_character: A character on which formatting should be triggered, like `{`.

* more\_trigger\_character: More trigger characters.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_registration_options.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentOnTypeFormattingRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  first_trigger_character: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  more_trigger_character: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentOnTypeFormattingRegistrationOptions{}

================================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_on_type_formatting_registration_options.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* first\_trigger\_character: A character on which formatting should be triggered, like `{`.

* more\_trigger\_character: More trigger characters.





GenLSP.Structures.DocumentRangeFormattingClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DocumentRangeFormattingClientCapabilities

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================================================================

Client capabilities of a {@link DocumentRangeFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentRangeFormattingClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether range formatting supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_client_capabilities.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentRangeFormattingClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentRangeFormattingClientCapabilities{}

==============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_client_capabilities.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether range formatting supports dynamic registration.





GenLSP.Structures.DocumentRangeFormattingOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_options.ex#L2 "View Source")

GenLSP.Structures.DocumentRangeFormattingOptions

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================================

Provider options for a {@link DocumentRangeFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentRangeFormattingOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_options.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentRangeFormattingOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentRangeFormattingOptions{}

===================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_options.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.DocumentRangeFormattingParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_params.ex#L2 "View Source")

GenLSP.Structures.DocumentRangeFormattingParams

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================================================

The parameters of a {@link DocumentRangeFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentRangeFormattingParams{}](#__struct__/0)

Fields

------

* text\_document: The document to format.

* range: The range to format

* options: The format options

* work\_done\_token: An optional token that a server can use to report work done progress.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_params.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentRangeFormattingParams{

  options: [GenLSP.Structures.FormattingOptions.t](GenLSP.Structures.FormattingOptions.html#t:t/0)(),

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentRangeFormattingParams{}

==================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_params.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document to format.

* range: The range to format

* options: The format options

* work\_done\_token: An optional token that a server can use to report work done progress.





GenLSP.Structures.DocumentRangeFormattingRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_registration_options.ex#L2 "View Source")

GenLSP.Structures.DocumentRangeFormattingRegistrationOptions

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================================================================

Registration options for a {@link DocumentRangeFormattingRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentRangeFormattingRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_registration_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentRangeFormattingRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentRangeFormattingRegistrationOptions{}

===============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_range_formatting_registration_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.DocumentSymbol — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol.ex#L2 "View Source")

GenLSP.Structures.DocumentSymbol

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================

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.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentSymbol{}](#__struct__/0)

Fields

------

* name: The name of this symbol. Will be displayed in the user interface and therefore must not be

an empty string or a string only consisting of white spaces.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol.ex#L35 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentSymbol{

  children: [[t](#t:t/0)()] | nil,

  deprecated: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  detail: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  kind: [GenLSP.Enumerations.SymbolKind.t](GenLSP.Enumerations.SymbolKind.html#t:t/0)(),

  name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  selection_range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  tags: [[GenLSP.Enumerations.SymbolTag.t](GenLSP.Enumerations.SymbolTag.html#t:t/0)()] | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentSymbol{}

===================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol.ex#L35 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* name: The name of this symbol. Will be displayed in the user interface and therefore must not be

an empty string or a string only consisting of white spaces.

* detail: More detail for this symbol, e.g the signature of a function.

* kind: The kind of this symbol.

* tags: Tags for this document symbol.

@since 3.16.0

* deprecated: Indicates if this symbol is deprecated.

@deprecated Use tags instead

* range: The range enclosing this symbol not including leading/trailing whitespace but everything else

like comments. This information is typically used to determine if the clients cursor is

inside the symbol to reveal in the symbol in the UI.

* selection\_range: The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.

Must be contained by the `range`.

* children: Children of this symbol, e.g. properties of a class.





GenLSP.Structures.DocumentSymbolClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.DocumentSymbolClientCapabilities

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

Client Capabilities for a {@link DocumentSymbolRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentSymbolClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether document symbol supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_client_capabilities.ex#L29 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentSymbolClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  hierarchical_document_symbol_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  label_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  symbol_kind: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  tag_support: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentSymbolClientCapabilities{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_client_capabilities.ex#L29 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether document symbol supports dynamic registration.

* symbol\_kind: Specific capabilities for the `SymbolKind` in the

`textDocument/documentSymbol` request.

* hierarchical\_document\_symbol\_support: The client supports hierarchical document symbols.

* tag\_support: The client supports tags on `SymbolInformation`. Tags are supported on

`DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true.

Clients supporting tags have to handle unknown tags gracefully.

@since 3.16.0

* label\_support: The client supports an additional label presented in the UI when

registering a document symbol provider.

@since 3.16.0





GenLSP.Structures.DocumentSymbolOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_options.ex#L2 "View Source")

GenLSP.Structures.DocumentSymbolOptions

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================

Provider options for a {@link DocumentSymbolRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentSymbolOptions{}](#__struct__/0)

Fields

------

* label: A human-readable string that is shown when multiple outlines trees

are shown for the same document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_options.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentSymbolOptions{

  label: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentSymbolOptions{}

==========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_options.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* label: A human-readable string that is shown when multiple outlines trees

are shown for the same document.

@since 3.16.0

* work\_done\_progress





GenLSP.Structures.DocumentSymbolParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_params.ex#L2 "View Source")

GenLSP.Structures.DocumentSymbolParams

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

Parameters for a {@link DocumentSymbolRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentSymbolParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_params.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentSymbolParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentSymbolParams{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_params.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.DocumentSymbolRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_registration_options.ex#L2 "View Source")

GenLSP.Structures.DocumentSymbolRegistrationOptions

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================================

Registration options for a {@link DocumentSymbolRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.DocumentSymbolRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_registration_options.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.DocumentSymbolRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  label: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.DocumentSymbolRegistrationOptions{}

======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/document_symbol_registration_options.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* label: A human-readable string that is shown when multiple outlines trees

are shown for the same document.

@since 3.16.0





GenLSP.Structures.ExecuteCommandClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.ExecuteCommandClientCapabilities

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

The client capabilities of a {@link ExecuteCommandRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ExecuteCommandClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Execute command supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_client_capabilities.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.ExecuteCommandClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ExecuteCommandClientCapabilities{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_client_capabilities.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Execute command supports dynamic registration.





GenLSP.Structures.ExecuteCommandOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_options.ex#L2 "View Source")

GenLSP.Structures.ExecuteCommandOptions

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================

The server capabilities of a {@link ExecuteCommandRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ExecuteCommandOptions{}](#__struct__/0)

Fields

------

* commands: The commands to be executed on the server

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.ExecuteCommandOptions{

  commands: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()],

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ExecuteCommandOptions{}

==========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* commands: The commands to be executed on the server

* work\_done\_progress





GenLSP.Structures.ExecuteCommandParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_params.ex#L2 "View Source")

GenLSP.Structures.ExecuteCommandParams

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

The parameters of a {@link ExecuteCommandRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ExecuteCommandParams{}](#__struct__/0)

Fields

------

* command: The identifier of the actual command handler.

* arguments: Arguments that the command should be invoked with.

* work\_done\_token: An optional token that a server can use to report work done progress.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_params.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.ExecuteCommandParams{

  arguments: [[GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)()] | nil,

  command: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ExecuteCommandParams{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_params.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* command: The identifier of the actual command handler.

* arguments: Arguments that the command should be invoked with.

* work\_done\_token: An optional token that a server can use to report work done progress.





GenLSP.Structures.ExecuteCommandRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_registration_options.ex#L2 "View Source")

GenLSP.Structures.ExecuteCommandRegistrationOptions

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================================

Registration options for a {@link ExecuteCommandRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ExecuteCommandRegistrationOptions{}](#__struct__/0)

Fields

------

* commands: The commands to be executed on the server

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_registration_options.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.ExecuteCommandRegistrationOptions{

  commands: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ExecuteCommandRegistrationOptions{}

======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execute_command_registration_options.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* commands: The commands to be executed on the server





GenLSP.Structures.ExecutionSummary — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execution_summary.ex#L2 "View Source")

GenLSP.Structures.ExecutionSummary

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ExecutionSummary{}](#__struct__/0)

Fields

------

* execution\_order: A strict monotonically increasing value

indicating the execution order of a cell

inside a notebook.

* success: Whether the execution was successful or

not if known by the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execution_summary.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.ExecutionSummary{

  execution_order: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)(),

  success: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ExecutionSummary{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/execution_summary.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* execution\_order: A strict monotonically increasing value

indicating the execution order of a cell

inside a notebook.

* success: Whether the execution was successful or

not if known by the client.





GenLSP.Structures.FileCreate — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_create.ex#L2 "View Source")

GenLSP.Structures.FileCreate

(gen\_lsp v0.6.0)

============================================================================================================================================================================================

Represents information on a file/folder create.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FileCreate{}](#__struct__/0)

Fields

------

* uri: A file:// URI for the location of the file/folder being created.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_create.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.FileCreate{uri: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FileCreate{}

===============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_create.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: A file:// URI for the location of the file/folder being created.





GenLSP.Structures.FileDelete — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_delete.ex#L2 "View Source")

GenLSP.Structures.FileDelete

(gen\_lsp v0.6.0)

============================================================================================================================================================================================

Represents information on a file/folder delete.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FileDelete{}](#__struct__/0)

Fields

------

* uri: A file:// URI for the location of the file/folder being deleted.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_delete.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.FileDelete{uri: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FileDelete{}

===============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_delete.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: A file:// URI for the location of the file/folder being deleted.





GenLSP.Structures.FileEvent — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_event.ex#L2 "View Source")

GenLSP.Structures.FileEvent

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================

An event describing a file change.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FileEvent{}](#__struct__/0)

Fields

------

* uri: The file's uri.

* type: The change type.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_event.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.FileEvent{

  type: [GenLSP.Enumerations.FileChangeType.t](GenLSP.Enumerations.FileChangeType.html#t:t/0)(),

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FileEvent{}

==============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_event.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: The file's uri.

* type: The change type.





GenLSP.Structures.FileOperationClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.FileOperationClientCapabilities

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

Capabilities relating to events from file operations by the user in the client.

These events do not come from the file system, they come from user operations

like renaming a file in the UI.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FileOperationClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether the client supports dynamic registration for file requests/notifications.

* did\_create: The client has support for sending didCreateFiles notifications.

* will\_create: The client has support for sending willCreateFiles requests.

* did\_rename: The client has support for sending didRenameFiles notifications.

* will\_rename: The client has support for sending willRenameFiles requests.

* did\_delete: The client has support for sending didDeleteFiles notifications.

* will\_delete: The client has support for sending willDeleteFiles requests.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_client_capabilities.ex#L28 "View Source")

```

@type t() :: %GenLSP.Structures.FileOperationClientCapabilities{

  did_create: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  did_delete: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  did_rename: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  will_create: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  will_delete: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  will_rename: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FileOperationClientCapabilities{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_client_capabilities.ex#L28 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether the client supports dynamic registration for file requests/notifications.

* did\_create: The client has support for sending didCreateFiles notifications.

* will\_create: The client has support for sending willCreateFiles requests.

* did\_rename: The client has support for sending didRenameFiles notifications.

* will\_rename: The client has support for sending willRenameFiles requests.

* did\_delete: The client has support for sending didDeleteFiles notifications.

* will\_delete: The client has support for sending willDeleteFiles requests.





GenLSP.Structures.FileOperationFilter — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_filter.ex#L2 "View Source")

GenLSP.Structures.FileOperationFilter

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

A filter to describe in which file operation requests or notifications

the server is interested in receiving.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FileOperationFilter{}](#__struct__/0)

Fields

------

* scheme: A Uri scheme like `file` or `untitled`.

* pattern: The actual file operation pattern.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_filter.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.FileOperationFilter{

  pattern: [GenLSP.Structures.FileOperationPattern.t](GenLSP.Structures.FileOperationPattern.html#t:t/0)(),

  scheme: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FileOperationFilter{}

========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_filter.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* scheme: A Uri scheme like `file` or `untitled`.

* pattern: The actual file operation pattern.





GenLSP.Structures.FileOperationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_options.ex#L2 "View Source")

GenLSP.Structures.FileOperationOptions

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

Options for notifications/requests for user operations on files.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FileOperationOptions{}](#__struct__/0)

Fields

------

* did\_create: The server is interested in receiving didCreateFiles notifications.

* will\_create: The server is interested in receiving willCreateFiles requests.

* did\_rename: The server is interested in receiving didRenameFiles notifications.

* will\_rename: The server is interested in receiving willRenameFiles requests.

* did\_delete: The server is interested in receiving didDeleteFiles file notifications.

* will\_delete: The server is interested in receiving willDeleteFiles file requests.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_options.ex#L24 "View Source")

```

@type t() :: %GenLSP.Structures.FileOperationOptions{

  did_create: [GenLSP.Structures.FileOperationRegistrationOptions.t](GenLSP.Structures.FileOperationRegistrationOptions.html#t:t/0)() | nil,

  did_delete: [GenLSP.Structures.FileOperationRegistrationOptions.t](GenLSP.Structures.FileOperationRegistrationOptions.html#t:t/0)() | nil,

  did_rename: [GenLSP.Structures.FileOperationRegistrationOptions.t](GenLSP.Structures.FileOperationRegistrationOptions.html#t:t/0)() | nil,

  will_create: [GenLSP.Structures.FileOperationRegistrationOptions.t](GenLSP.Structures.FileOperationRegistrationOptions.html#t:t/0)() | nil,

  will_delete: [GenLSP.Structures.FileOperationRegistrationOptions.t](GenLSP.Structures.FileOperationRegistrationOptions.html#t:t/0)() | nil,

  will_rename: [GenLSP.Structures.FileOperationRegistrationOptions.t](GenLSP.Structures.FileOperationRegistrationOptions.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FileOperationOptions{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_options.ex#L24 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* did\_create: The server is interested in receiving didCreateFiles notifications.

* will\_create: The server is interested in receiving willCreateFiles requests.

* did\_rename: The server is interested in receiving didRenameFiles notifications.

* will\_rename: The server is interested in receiving willRenameFiles requests.

* did\_delete: The server is interested in receiving didDeleteFiles file notifications.

* will\_delete: The server is interested in receiving willDeleteFiles file requests.





GenLSP.Structures.FileOperationPattern — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_pattern.ex#L2 "View Source")

GenLSP.Structures.FileOperationPattern

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

A pattern to describe in which file operation requests or notifications

the server is interested in receiving.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FileOperationPattern{}](#__struct__/0)

Fields

------

* glob: The glob pattern to match. Glob patterns can have the following syntax

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_pattern.ex#L30 "View Source")

```

@type t() :: %GenLSP.Structures.FileOperationPattern{

  glob: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  matches: [GenLSP.Enumerations.FileOperationPatternKind.t](GenLSP.Enumerations.FileOperationPatternKind.html#t:t/0)() | nil,

  options: [GenLSP.Structures.FileOperationPatternOptions.t](GenLSP.Structures.FileOperationPatternOptions.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FileOperationPattern{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_pattern.ex#L30 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* glob: The glob pattern to match. Glob patterns can have the following syntax:

	+ `*` to match one or more characters in a path segment

	+ `?` to match on one character in a path segment

	+ `**` to match any number of path segments, including none

	+ `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)

	+ `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)

	+ `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)

* matches: Whether to match files or folders with this pattern.

Matches both if undefined.

* options: Additional options used during matching.





GenLSP.Structures.FileOperationPatternOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_pattern_options.ex#L2 "View Source")

GenLSP.Structures.FileOperationPatternOptions

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================

Matching options for the file operation pattern.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FileOperationPatternOptions{}](#__struct__/0)

Fields

------

* ignore\_case: The pattern should be matched ignoring casing.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_pattern_options.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.FileOperationPatternOptions{

  ignore_case: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FileOperationPatternOptions{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_pattern_options.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* ignore\_case: The pattern should be matched ignoring casing.





GenLSP.Structures.FileOperationRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_registration_options.ex#L2 "View Source")

GenLSP.Structures.FileOperationRegistrationOptions

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

The options to register for file operations.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FileOperationRegistrationOptions{}](#__struct__/0)

Fields

------

* filters: The actual filters.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_registration_options.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.FileOperationRegistrationOptions{

  filters: [[GenLSP.Structures.FileOperationFilter.t](GenLSP.Structures.FileOperationFilter.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FileOperationRegistrationOptions{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_operation_registration_options.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* filters: The actual filters.





GenLSP.Structures.FileRename — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_rename.ex#L2 "View Source")

GenLSP.Structures.FileRename

(gen\_lsp v0.6.0)

============================================================================================================================================================================================

Represents information on a file/folder rename.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FileRename{}](#__struct__/0)

Fields

------

* old\_uri: A file:// URI for the original location of the file/folder being renamed.

* new\_uri: A file:// URI for the new location of the file/folder being renamed.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_rename.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.FileRename{new_uri: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(), old_uri: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FileRename{}

===============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_rename.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* old\_uri: A file:// URI for the original location of the file/folder being renamed.

* new\_uri: A file:// URI for the new location of the file/folder being renamed.





GenLSP.Structures.FileSystemWatcher — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_system_watcher.ex#L2 "View Source")

GenLSP.Structures.FileSystemWatcher

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FileSystemWatcher{}](#__struct__/0)

Fields

------

* glob\_pattern: The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_system_watcher.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.FileSystemWatcher{

  glob_pattern: [GenLSP.TypeAlias.GlobPattern.t](GenLSP.TypeAlias.GlobPattern.html#t:t/0)(),

  kind: [GenLSP.Enumerations.WatchKind.t](GenLSP.Enumerations.WatchKind.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FileSystemWatcher{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/file_system_watcher.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* glob\_pattern: The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.

@since 3.17.0 support for relative patterns.

* kind: The kind of events of interest. If omitted it defaults

to WatchKind.Create | WatchKind.Change | WatchKind.Delete

which is 7.





GenLSP.Structures.FoldingRange — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range.ex#L2 "View Source")

GenLSP.Structures.FoldingRange

(gen\_lsp v0.6.0)

================================================================================================================================================================================================

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.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FoldingRange{}](#__struct__/0)

Fields

------

* start\_line: The zero-based start line of the range to fold. The folded area starts after the line's last character.

To be valid, the end must be zero or larger and smaller than the number of lines in the document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range.ex#L31 "View Source")

```

@type t() :: %GenLSP.Structures.FoldingRange{

  collapsed_text: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  end_character: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)() | nil,

  end_line: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)(),

  kind: [GenLSP.Enumerations.FoldingRangeKind.t](GenLSP.Enumerations.FoldingRangeKind.html#t:t/0)() | nil,

  start_character: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)() | nil,

  start_line: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FoldingRange{}

=================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range.ex#L31 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* start\_line: The zero-based start line of the range to fold. The folded area starts after the line's last character.

To be valid, the end must be zero or larger and smaller than the number of lines in the document.

* start\_character: The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.

* end\_line: The zero-based end line of the range to fold. The folded area ends with the line's last character.

To be valid, the end must be zero or larger and smaller than the number of lines in the document.

* end\_character: The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.

* kind: Describes the kind of the folding range such as 'comment' or 'region'. The kind

is used to categorize folding ranges and used by commands like 'Fold all comments'.

See {@link FoldingRangeKind} for an enumeration of standardized kinds.

* collapsed\_text: The text that the client should show when the specified range is

collapsed. If not defined or not supported by the client, a default

will be chosen by the client.

@since 3.17.0





GenLSP.Structures.FoldingRangeClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.FoldingRangeClientCapabilities

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FoldingRangeClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration for folding range

providers. If this is set to `true` the client supports the new

`FoldingRangeRegistrationOptions` return value for the corresponding

server capability as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_client_capabilities.ex#L28 "View Source")

```

@type t() :: %GenLSP.Structures.FoldingRangeClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  folding_range: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  folding_range_kind: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  line_folding_only: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  range_limit: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FoldingRangeClientCapabilities{}

===================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_client_capabilities.ex#L28 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration for folding range

providers. If this is set to `true` the client supports the new

`FoldingRangeRegistrationOptions` return value for the corresponding

server capability as well.

* range\_limit: The maximum number of folding ranges that the client prefers to receive

per document. The value serves as a hint, servers are free to follow the

limit.

* line\_folding\_only: If set, the client signals that it only supports folding complete lines.

If set, client will ignore specified `startCharacter` and `endCharacter`

properties in a FoldingRange.

* folding\_range\_kind: Specific options for the folding range kind.

@since 3.17.0

* folding\_range: Specific options for the folding range.

@since 3.17.0





GenLSP.Structures.FoldingRangeOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_options.ex#L2 "View Source")

GenLSP.Structures.FoldingRangeOptions

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FoldingRangeOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_options.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.FoldingRangeOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FoldingRangeOptions{}

========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_options.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.FoldingRangeParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_params.ex#L2 "View Source")

GenLSP.Structures.FoldingRangeParams

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================

Parameters for a {@link FoldingRangeRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FoldingRangeParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_params.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.FoldingRangeParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FoldingRangeParams{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_params.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.FoldingRangeRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_registration_options.ex#L2 "View Source")

GenLSP.Structures.FoldingRangeRegistrationOptions

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FoldingRangeRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_registration_options.ex#L16 "View Source")

```

@type t() :: %GenLSP.Structures.FoldingRangeRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FoldingRangeRegistrationOptions{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/folding_range_registration_options.ex#L16 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.FormattingOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/formatting_options.ex#L2 "View Source")

GenLSP.Structures.FormattingOptions

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

Value-object describing what options formatting should use.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FormattingOptions{}](#__struct__/0)

Fields

------

* tab\_size: Size of a tab in spaces.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/formatting_options.ex#L27 "View Source")

```

@type t() :: %GenLSP.Structures.FormattingOptions{

  insert_final_newline: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  insert_spaces: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)(),

  tab_size: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)(),

  trim_final_newlines: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  trim_trailing_whitespace: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FormattingOptions{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/formatting_options.ex#L27 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* tab\_size: Size of a tab in spaces.

* insert\_spaces: Prefer spaces over tabs.

* trim\_trailing\_whitespace: Trim trailing whitespace on a line.

@since 3.15.0

* insert\_final\_newline: Insert a newline character at the end of the file if one does not exist.

@since 3.15.0

* trim\_final\_newlines: Trim all newlines after the final newline at the end of the file.

@since 3.15.0





GenLSP.Structures.FullDocumentDiagnosticReport — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/full_document_diagnostic_report.ex#L2 "View Source")

GenLSP.Structures.FullDocumentDiagnosticReport

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================

A diagnostic report with a full set of problems.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.FullDocumentDiagnosticReport{}](#__struct__/0)

Fields

------

* kind: A full document diagnostic report.

* result\_id: An optional result id. If provided it will

be sent on the next diagnostic request for the

same document.

* items: The actual items.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/full_document_diagnostic_report.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.FullDocumentDiagnosticReport{

  items: [[GenLSP.Structures.Diagnostic.t](GenLSP.Structures.Diagnostic.html#t:t/0)()],

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  result_id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.FullDocumentDiagnosticReport{}

=================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/full_document_diagnostic_report.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* kind: A full document diagnostic report.

* result\_id: An optional result id. If provided it will

be sent on the next diagnostic request for the

same document.

* items: The actual items.





GenLSP.Structures.GeneralClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/general_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.GeneralClientCapabilities

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================

General client capabilities.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.GeneralClientCapabilities{}](#__struct__/0)

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)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/general_client_capabilities.ex#L48 "View Source")

```

@type t() :: %GenLSP.Structures.GeneralClientCapabilities{

  markdown: [GenLSP.Structures.MarkdownClientCapabilities.t](GenLSP.Structures.MarkdownClientCapabilities.html#t:t/0)() | nil,

  position_encodings: [[GenLSP.Enumerations.PositionEncodingKind.t](GenLSP.Enumerations.PositionEncodingKind.html#t:t/0)()] | nil,

  regular_expressions:

    [GenLSP.Structures.RegularExpressionsClientCapabilities.t](GenLSP.Structures.RegularExpressionsClientCapabilities.html#t:t/0)() | nil,

  stale_request_support: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.GeneralClientCapabilities{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/general_client_capabilities.ex#L48 "View Source")

(struct)

[fields](#__struct__/0-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





GenLSP.Structures.Hover — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover.ex#L2 "View Source")

GenLSP.Structures.Hover

(gen\_lsp v0.6.0)

=================================================================================================================================================================================

The result of a hover request.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.Hover{}](#__struct__/0)

Fields

------

* contents: The hover's content

* range: An optional range inside the text document that is used to

visualize the hover, e.g. by changing the background color.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.Hover{

  contents:

    [GenLSP.Structures.MarkupContent.t](GenLSP.Structures.MarkupContent.html#t:t/0)()

    | [GenLSP.TypeAlias.MarkedString.t](GenLSP.TypeAlias.MarkedString.html#t:t/0)()

    | [[GenLSP.TypeAlias.MarkedString.t](GenLSP.TypeAlias.MarkedString.html#t:t/0)()],

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.Hover{}

==========================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* contents: The hover's content

* range: An optional range inside the text document that is used to

visualize the hover, e.g. by changing the background color.





GenLSP.Structures.HoverClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.HoverClientCapabilities

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.HoverClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether hover supports dynamic registration.

* content\_format: Client supports the following content formats for the content

property. The order describes the preferred format of the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_client_capabilities.ex#L15 "View Source")

```

@type t() :: %GenLSP.Structures.HoverClientCapabilities{

  content_format: [[GenLSP.Enumerations.MarkupKind.t](GenLSP.Enumerations.MarkupKind.html#t:t/0)()] | nil,

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.HoverClientCapabilities{}

============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_client_capabilities.ex#L15 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether hover supports dynamic registration.

* content\_format: Client supports the following content formats for the content

property. The order describes the preferred format of the client.





GenLSP.Structures.HoverOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_options.ex#L2 "View Source")

GenLSP.Structures.HoverOptions

(gen\_lsp v0.6.0)

================================================================================================================================================================================================

Hover options.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.HoverOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_options.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.HoverOptions{work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.HoverOptions{}

=================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_options.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.HoverParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_params.ex#L2 "View Source")

GenLSP.Structures.HoverParams

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================

Parameters for a {@link HoverRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.HoverParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_params.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.HoverParams{

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.HoverParams{}

================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_params.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.HoverRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_registration_options.ex#L2 "View Source")

GenLSP.Structures.HoverRegistrationOptions

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================

Registration options for a {@link HoverRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.HoverRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_registration_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.HoverRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.HoverRegistrationOptions{}

=============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/hover_registration_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.ImplementationClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.ImplementationClientCapabilities

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================================

@since 3.6.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ImplementationClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `ImplementationRegistrationOptions` return value

for the corresponding server capability as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_client_capabilities.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.ImplementationClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  link_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ImplementationClientCapabilities{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_client_capabilities.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `ImplementationRegistrationOptions` return value

for the corresponding server capability as well.

* link\_support: The client supports additional metadata in the form of definition links.

@since 3.14.0





GenLSP.Structures.ImplementationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_options.ex#L2 "View Source")

GenLSP.Structures.ImplementationOptions

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ImplementationOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_options.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.ImplementationOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ImplementationOptions{}

==========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_options.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.ImplementationParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_params.ex#L2 "View Source")

GenLSP.Structures.ImplementationParams

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ImplementationParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_params.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.ImplementationParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ImplementationParams{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_params.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.ImplementationRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_registration_options.ex#L2 "View Source")

GenLSP.Structures.ImplementationRegistrationOptions

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ImplementationRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_registration_options.ex#L16 "View Source")

```

@type t() :: %GenLSP.Structures.ImplementationRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ImplementationRegistrationOptions{}

======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/implementation_registration_options.ex#L16 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.InitializeError — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialize_error.ex#L2 "View Source")

GenLSP.Structures.InitializeError

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================

The data type of the ResponseError if the

initialize request fails.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InitializeError{}](#__struct__/0)

Fields

------

* retry: Indicates whether the client execute the following retry logic:

(1) show the message provided by the ResponseError to the user

(2) user selects retry or cancel

(3) if user selected retry the initialize method is sent again.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialize_error.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.InitializeError{retry: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InitializeError{}

====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialize_error.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* retry: Indicates whether the client execute the following retry logic:

(1) show the message provided by the ResponseError to the user

(2) user selects retry or cancel

(3) if user selected retry the initialize method is sent again.





GenLSP.Structures.InitializeParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialize_params.ex#L2 "View Source")

GenLSP.Structures.InitializeParams

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InitializeParams{}](#__struct__/0)

Fields

------

* process\_id: The process Id of the parent process that started

the server.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialize_params.ex#L47 "View Source")

```

@type t() :: %GenLSP.Structures.InitializeParams{

  capabilities: [GenLSP.Structures.ClientCapabilities.t](GenLSP.Structures.ClientCapabilities.html#t:t/0)(),

  client_info: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  initialization_options: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  locale: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  process_id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  root_path: ([String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil) | nil,

  root_uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)() | nil,

  trace: [GenLSP.Enumerations.TraceValues.t](GenLSP.Enumerations.TraceValues.html#t:t/0)() | nil,

  workspace_folders: ([[GenLSP.Structures.WorkspaceFolder.t](GenLSP.Structures.WorkspaceFolder.html#t:t/0)()] | nil) | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InitializeParams{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialize_params.ex#L47 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* process\_id: The process Id of the parent process that started

the server.

Is `null` if the process has not been started by another process.

If the parent process is not alive then the server should exit.

* client\_info: Information about the client

@since 3.15.0

* locale: The locale the client is currently showing the user interface

in. This must not necessarily be the locale of the operating

system.

Uses IETF language tags as the value's syntax

(See <https://en.wikipedia.org/wiki/IETF_language_tag>)

@since 3.16.0

* root\_path: The rootPath of the workspace. Is null

if no folder is open.

@deprecated in favour of rootUri.

* root\_uri: The rootUri of the workspace. Is null if no

folder is open. If both `rootPath` and `rootUri` are set

`rootUri` wins.

@deprecated in favour of workspaceFolders.

* capabilities: The capabilities provided by the client (editor or tool)

* initialization\_options: User provided initialization options.

* trace: The initial trace setting. If omitted trace is disabled ('off').

* workspace\_folders: The workspace folders configured in the client when the server starts.

This property is only available if the client supports workspace folders.

It can be `null` if the client supports workspace folders but none are

configured.

@since 3.6.0





GenLSP.Structures.InitializeResult — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialize_result.ex#L2 "View Source")

GenLSP.Structures.InitializeResult

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================

The result returned from an initialize request.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InitializeResult{}](#__struct__/0)

Fields

------

* capabilities: The capabilities the language server provides.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialize_result.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.InitializeResult{

  capabilities: [GenLSP.Structures.ServerCapabilities.t](GenLSP.Structures.ServerCapabilities.html#t:t/0)(),

  server_info: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InitializeResult{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialize_result.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* capabilities: The capabilities the language server provides.

* server\_info: Information about the server.

@since 3.15.0





GenLSP.Structures.InitializedParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialized_params.ex#L2 "View Source")

GenLSP.Structures.InitializedParams

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InitializedParams{}](#__struct__/0)

Fields

------

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialized_params.ex#L12 "View Source")

```

@type t() :: %GenLSP.Structures.InitializedParams{}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InitializedParams{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/initialized_params.ex#L12 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------





GenLSP.Structures.InlayHint — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint.ex#L2 "View Source")

GenLSP.Structures.InlayHint

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================

Inlay hint information.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlayHint{}](#__struct__/0)

Fields

------

* position: The position of this hint.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint.ex#L43 "View Source")

```

@type t() :: %GenLSP.Structures.InlayHint{

  data: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  kind: [GenLSP.Enumerations.InlayHintKind.t](GenLSP.Enumerations.InlayHintKind.html#t:t/0)() | nil,

  label: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | [[GenLSP.Structures.InlayHintLabelPart.t](GenLSP.Structures.InlayHintLabelPart.html#t:t/0)()],

  padding_left: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  padding_right: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_edits: [[GenLSP.Structures.TextEdit.t](GenLSP.Structures.TextEdit.html#t:t/0)()] | nil,

  tooltip: ([String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | [GenLSP.Structures.MarkupContent.t](GenLSP.Structures.MarkupContent.html#t:t/0)()) | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlayHint{}

==============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint.ex#L43 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* position: The position of this hint.

* label: The label of this hint. A human readable string or an array of

InlayHintLabelPart label parts.

*Note* that neither the string nor the label part can be empty.

* kind: The kind of this hint. Can be omitted in which case the client

should fall back to a reasonable default.

* text\_edits: Optional text edits that are performed when accepting this inlay hint.

*Note* that edits are expected to change the document so that the inlay

hint (or its nearest variant) is now part of the document and the inlay

hint itself is now obsolete.

* tooltip: The tooltip text when you hover over this item.

* padding\_left: Render padding before the hint.

Note: Padding should use the editor's background color, not the

background color of the hint itself. That means padding can be used

to visually align/separate an inlay hint.

* padding\_right: Render padding after the hint.

Note: Padding should use the editor's background color, not the

background color of the hint itself. That means padding can be used

to visually align/separate an inlay hint.

* data: A data entry field that is preserved on an inlay hint between

a `textDocument/inlayHint` and a `inlayHint/resolve` request.





GenLSP.Structures.InlayHintClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.InlayHintClientCapabilities

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================

Inlay hint client capabilities.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlayHintClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether inlay hints support dynamic registration.

* resolve\_support: Indicates which properties a client can resolve lazily on an inlay

hint.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_client_capabilities.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.InlayHintClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  resolve_support: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlayHintClientCapabilities{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_client_capabilities.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether inlay hints support dynamic registration.

* resolve\_support: Indicates which properties a client can resolve lazily on an inlay

hint.





GenLSP.Structures.InlayHintLabelPart — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_label_part.ex#L2 "View Source")

GenLSP.Structures.InlayHintLabelPart

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================

An inlay hint label part allows for interactive and composite labels

of inlay hints.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlayHintLabelPart{}](#__struct__/0)

Fields

------

* value: The value of this label part.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_label_part.ex#L38 "View Source")

```

@type t() :: %GenLSP.Structures.InlayHintLabelPart{

  command: [GenLSP.Structures.Command.t](GenLSP.Structures.Command.html#t:t/0)() | nil,

  location: [GenLSP.Structures.Location.t](GenLSP.Structures.Location.html#t:t/0)() | nil,

  tooltip: ([String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | [GenLSP.Structures.MarkupContent.t](GenLSP.Structures.MarkupContent.html#t:t/0)()) | nil,

  value: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlayHintLabelPart{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_label_part.ex#L38 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* value: The value of this label part.

* tooltip: The tooltip text when you hover over this label part. Depending on

the client capability `inlayHint.resolveSupport` clients might resolve

this property late using the resolve request.

* location: An optional source code location that represents this

label part.

The editor will use this location for the hover and for code navigation

features: This part will become a clickable link that resolves to the

definition of the symbol at the given location (not necessarily the

location itself), it shows the hover that shows at the given location,

and it shows a context menu with further code navigation commands.

Depending on the client capability `inlayHint.resolveSupport` clients

might resolve this property late using the resolve request.

* command: An optional command for this label part.

Depending on the client capability `inlayHint.resolveSupport` clients

might resolve this property late using the resolve request.





GenLSP.Structures.InlayHintOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_options.ex#L2 "View Source")

GenLSP.Structures.InlayHintOptions

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

Inlay hint options used during static registration.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlayHintOptions{}](#__struct__/0)

Fields

------

* resolve\_provider: The server provides support to resolve additional

information for an inlay hint item.

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_options.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.InlayHintOptions{

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlayHintOptions{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_options.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* resolve\_provider: The server provides support to resolve additional

information for an inlay hint item.

* work\_done\_progress





GenLSP.Structures.InlayHintParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_params.ex#L2 "View Source")

GenLSP.Structures.InlayHintParams

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================

A parameter literal used in inlay hint requests.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlayHintParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* range: The document range for which inlay hints should be computed.

* work\_done\_token: An optional token that a server can use to report work done progress.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.InlayHintParams{

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlayHintParams{}

====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* range: The document range for which inlay hints should be computed.

* work\_done\_token: An optional token that a server can use to report work done progress.





GenLSP.Structures.InlayHintRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_registration_options.ex#L2 "View Source")

GenLSP.Structures.InlayHintRegistrationOptions

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================

Inlay hint options used during static or dynamic registration.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlayHintRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* resolve\_provider: The server provides support to resolve additional

information for an inlay hint item.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_registration_options.ex#L24 "View Source")

```

@type t() :: %GenLSP.Structures.InlayHintRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlayHintRegistrationOptions{}

=================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_registration_options.ex#L24 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* resolve\_provider: The server provides support to resolve additional

information for an inlay hint item.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.InlayHintWorkspaceClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_workspace_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.InlayHintWorkspaceClientCapabilities

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================================================

Client workspace capabilities specific to inlay hints.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlayHintWorkspaceClientCapabilities{}](#__struct__/0)

Fields

------

* refresh\_support: Whether the client implementation supports a refresh request sent from

the server to the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_workspace_client_capabilities.ex#L25 "View Source")

```

@type t() :: %GenLSP.Structures.InlayHintWorkspaceClientCapabilities{

  refresh_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlayHintWorkspaceClientCapabilities{}

=========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inlay_hint_workspace_client_capabilities.ex#L25 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* refresh\_support: Whether the client implementation supports a refresh request sent from

the server to the client.

Note that this event is global and will force the client to refresh all

inlay hints currently shown. It should be used with absolute care and

is useful for situation where a server for example detects a project wide

change that requires such a calculation.





GenLSP.Structures.InlineValueClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.InlineValueClientCapabilities

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================================================

Client capabilities specific to inline values.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlineValueClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration for inline value providers.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_client_capabilities.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.InlineValueClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlineValueClientCapabilities{}

==================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_client_capabilities.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration for inline value providers.





GenLSP.Structures.InlineValueContext — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_context.ex#L2 "View Source")

GenLSP.Structures.InlineValueContext

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlineValueContext{}](#__struct__/0)

Fields

------

* frame\_id: The stack frame (as a DAP Id) where the execution has stopped.

* stopped\_location: The document range where execution has stopped.

Typically the end position of the range denotes the line where the inline values are shown.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_context.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.InlineValueContext{

  frame_id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  stopped_location: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlineValueContext{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_context.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* frame\_id: The stack frame (as a DAP Id) where the execution has stopped.

* stopped\_location: The document range where execution has stopped.

Typically the end position of the range denotes the line where the inline values are shown.





GenLSP.Structures.InlineValueEvaluatableExpression — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_evaluatable_expression.ex#L2 "View Source")

GenLSP.Structures.InlineValueEvaluatableExpression

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

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.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlineValueEvaluatableExpression{}](#__struct__/0)

Fields

------

* range: The document range for which the inline value applies.

The range is used to extract the evaluatable expression from the underlying document.

* expression: If specified the expression overrides the extracted expression.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_evaluatable_expression.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.InlineValueEvaluatableExpression{

  expression: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlineValueEvaluatableExpression{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_evaluatable_expression.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* range: The document range for which the inline value applies.

The range is used to extract the evaluatable expression from the underlying document.

* expression: If specified the expression overrides the extracted expression.





GenLSP.Structures.InlineValueOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_options.ex#L2 "View Source")

GenLSP.Structures.InlineValueOptions

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================

Inline value options used during static registration.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlineValueOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_options.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.InlineValueOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlineValueOptions{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_options.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.InlineValueParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_params.ex#L2 "View Source")

GenLSP.Structures.InlineValueParams

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

A parameter literal used in inline value requests.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlineValueParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* range: The document range for which inline values should be computed.

* context: Additional information about the context in which inline values were

requested.

* work\_done\_token: An optional token that a server can use to report work done progress.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_params.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.InlineValueParams{

  context: [GenLSP.Structures.InlineValueContext.t](GenLSP.Structures.InlineValueContext.html#t:t/0)(),

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlineValueParams{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_params.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* range: The document range for which inline values should be computed.

* context: Additional information about the context in which inline values were

requested.

* work\_done\_token: An optional token that a server can use to report work done progress.





GenLSP.Structures.InlineValueRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_registration_options.ex#L2 "View Source")

GenLSP.Structures.InlineValueRegistrationOptions

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================================

Inline value options used during static or dynamic registration.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlineValueRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_registration_options.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.InlineValueRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlineValueRegistrationOptions{}

===================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_registration_options.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.InlineValueText — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_text.ex#L2 "View Source")

GenLSP.Structures.InlineValueText

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================

Provide inline value as text.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlineValueText{}](#__struct__/0)

Fields

------

* range: The document range for which the inline value applies.

* text: The text of the inline value.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_text.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.InlineValueText{

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  text: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlineValueText{}

====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_text.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* range: The document range for which the inline value applies.

* text: The text of the inline value.





GenLSP.Structures.InlineValueVariableLookup — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_variable_lookup.ex#L2 "View Source")

GenLSP.Structures.InlineValueVariableLookup

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================

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.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlineValueVariableLookup{}](#__struct__/0)

Fields

------

* range: The document range for which the inline value applies.

The range is used to extract the variable name from the underlying document.

* variable\_name: If specified the name of the variable to look up.

* case\_sensitive\_lookup: How to perform the lookup.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_variable_lookup.ex#L24 "View Source")

```

@type t() :: %GenLSP.Structures.InlineValueVariableLookup{

  case_sensitive_lookup: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)(),

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  variable_name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlineValueVariableLookup{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_variable_lookup.ex#L24 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* range: The document range for which the inline value applies.

The range is used to extract the variable name from the underlying document.

* variable\_name: If specified the name of the variable to look up.

* case\_sensitive\_lookup: How to perform the lookup.





GenLSP.Structures.InlineValueWorkspaceClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_workspace_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.InlineValueWorkspaceClientCapabilities

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================================================

Client workspace capabilities specific to inline values.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InlineValueWorkspaceClientCapabilities{}](#__struct__/0)

Fields

------

* refresh\_support: Whether the client implementation supports a refresh request sent from the

server to the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_workspace_client_capabilities.ex#L25 "View Source")

```

@type t() :: %GenLSP.Structures.InlineValueWorkspaceClientCapabilities{

  refresh_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InlineValueWorkspaceClientCapabilities{}

===========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/inline_value_workspace_client_capabilities.ex#L25 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* refresh\_support: Whether the client implementation supports a refresh request sent from the

server to the client.

Note that this event is global and will force the client to refresh all

inline values currently shown. It should be used with absolute care and is

useful for situation where a server for example detects a project wide

change that requires such a calculation.





GenLSP.Structures.InsertReplaceEdit — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/insert_replace_edit.ex#L2 "View Source")

GenLSP.Structures.InsertReplaceEdit

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

A special text edit to provide an insert and a replace operation.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.InsertReplaceEdit{}](#__struct__/0)

Fields

------

* new\_text: The string to be inserted.

* insert: The range if the insert is requested

* replace: The range if the replace is requested.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/insert_replace_edit.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.InsertReplaceEdit{

  insert: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  new_text: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  replace: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.InsertReplaceEdit{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/insert_replace_edit.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* new\_text: The string to be inserted.

* insert: The range if the insert is requested

* replace: The range if the replace is requested.





GenLSP.Structures.LinkedEditingRangeClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.LinkedEditingRangeClientCapabilities

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================================================

Client capabilities for the linked editing range request.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.LinkedEditingRangeClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_client_capabilities.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.LinkedEditingRangeClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.LinkedEditingRangeClientCapabilities{}

=========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_client_capabilities.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.





GenLSP.Structures.LinkedEditingRangeOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_options.ex#L2 "View Source")

GenLSP.Structures.LinkedEditingRangeOptions

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.LinkedEditingRangeOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_options.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.LinkedEditingRangeOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.LinkedEditingRangeOptions{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_options.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.LinkedEditingRangeParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_params.ex#L2 "View Source")

GenLSP.Structures.LinkedEditingRangeParams

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.LinkedEditingRangeParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_params.ex#L15 "View Source")

```

@type t() :: %GenLSP.Structures.LinkedEditingRangeParams{

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.LinkedEditingRangeParams{}

=============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_params.ex#L15 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.LinkedEditingRangeRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_registration_options.ex#L2 "View Source")

GenLSP.Structures.LinkedEditingRangeRegistrationOptions

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.LinkedEditingRangeRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_registration_options.ex#L16 "View Source")

```

@type t() :: %GenLSP.Structures.LinkedEditingRangeRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.LinkedEditingRangeRegistrationOptions{}

==========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_range_registration_options.ex#L16 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.LinkedEditingRanges — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_ranges.ex#L2 "View Source")

GenLSP.Structures.LinkedEditingRanges

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

The result of a linked editing range request.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.LinkedEditingRanges{}](#__struct__/0)

Fields

------

* ranges: A list of ranges that can be edited together. The ranges must have

identical length and contain identical text content. The ranges cannot overlap.

* word\_pattern: An optional word pattern (regular expression) that describes valid contents for

the given ranges. If no pattern is provided, the client configuration's word

pattern will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_ranges.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.LinkedEditingRanges{

  ranges: [[GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()],

  word_pattern: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.LinkedEditingRanges{}

========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/linked_editing_ranges.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* ranges: A list of ranges that can be edited together. The ranges must have

identical length and contain identical text content. The ranges cannot overlap.

* word\_pattern: An optional word pattern (regular expression) that describes valid contents for

the given ranges. If no pattern is provided, the client configuration's word

pattern will be used.





GenLSP.Structures.Location — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/location.ex#L2 "View Source")

GenLSP.Structures.Location

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================

Represents a location inside a resource, such as a line

inside a text file.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.Location{}](#__struct__/0)

Fields

------

* uri

* range

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/location.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.Location{

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.Location{}

=============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/location.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri

* range





GenLSP.Structures.LocationLink — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/location_link.ex#L2 "View Source")

GenLSP.Structures.LocationLink

(gen\_lsp v0.6.0)

================================================================================================================================================================================================

Represents the connection of two locations. Provides additional metadata over normal {@link Location locations},

including an origin range.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.LocationLink{}](#__struct__/0)

Fields

------

* origin\_selection\_range: Span of the origin of this link.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/location_link.ex#L27 "View Source")

```

@type t() :: %GenLSP.Structures.LocationLink{

  origin_selection_range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)() | nil,

  target_range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  target_selection_range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  target_uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.LocationLink{}

=================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/location_link.ex#L27 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* origin\_selection\_range: Span of the origin of this link.

Used as the underlined span for mouse interaction. Defaults to the word range at

the definition position.

* target\_uri: The target resource identifier of this link.

* target\_range: The full target range of this link. If the target for example is a symbol then target range is the

range enclosing this symbol not including leading/trailing whitespace but everything else

like comments. This information is typically used to highlight the range in the editor.

* target\_selection\_range: The range that should be selected and revealed when this link is being followed, e.g the name of a function.

Must be contained by the `targetRange`. See also `DocumentSymbol#range`





GenLSP.Structures.LogMessageParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/log_message_params.ex#L2 "View Source")

GenLSP.Structures.LogMessageParams

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

The log message parameters.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.LogMessageParams{}](#__struct__/0)

Fields

------

* type: The message type. See {@link MessageType}

* message: The actual message.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/log_message_params.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.LogMessageParams{

  message: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  type: [GenLSP.Enumerations.MessageType.t](GenLSP.Enumerations.MessageType.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.LogMessageParams{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/log_message_params.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* type: The message type. See {@link MessageType}

* message: The actual message.





GenLSP.Structures.LogTraceParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/log_trace_params.ex#L2 "View Source")

GenLSP.Structures.LogTraceParams

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.LogTraceParams{}](#__struct__/0)

Fields

------

* message

* verbose

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/log_trace_params.ex#L14 "View Source")

```

@type t() :: %GenLSP.Structures.LogTraceParams{

  message: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  verbose: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.LogTraceParams{}

===================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/log_trace_params.ex#L14 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* message

* verbose





GenLSP.Structures.MarkdownClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/markdown_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.MarkdownClientCapabilities

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================================

Client capabilities specific to the used markdown parser.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.MarkdownClientCapabilities{}](#__struct__/0)

Fields

------

* parser: The name of the parser.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/markdown_client_capabilities.ex#L24 "View Source")

```

@type t() :: %GenLSP.Structures.MarkdownClientCapabilities{

  allowed_tags: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil,

  parser: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  version: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.MarkdownClientCapabilities{}

===============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/markdown_client_capabilities.ex#L24 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* parser: The name of the parser.

* version: The version of the parser.

* allowed\_tags: A list of HTML tags that the client allows / supports in

Markdown.

@since 3.17.0





GenLSP.Structures.MarkupContent — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/markup_content.ex#L2 "View Source")

GenLSP.Structures.MarkupContent

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================

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.

If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.

See <https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting>

Here is an example how such a string can be constructed using JavaScript / TypeScript:

```

let markdown: MarkdownContent = {

 kind: MarkupKind.Markdown,

 value: [

   '# Header',

   'Some text',

   '```typescript',

   'someCode();',

   '```'

 ].join('

')

};

```

*Please Note* that clients might sanitize the return markdown. A client could decide to

remove HTML from the markdown to avoid script execution.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.MarkupContent{}](#__struct__/0)

Fields

------

* kind: The type of the Markup

* value: The content itself

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/markup_content.ex#L39 "View Source")

```

@type t() :: %GenLSP.Structures.MarkupContent{

  kind: [GenLSP.Enumerations.MarkupKind.t](GenLSP.Enumerations.MarkupKind.html#t:t/0)(),

  value: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.MarkupContent{}

==================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/markup_content.ex#L39 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* kind: The type of the Markup

* value: The content itself





GenLSP.Structures.MessageActionItem — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/message_action_item.ex#L2 "View Source")

GenLSP.Structures.MessageActionItem

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.MessageActionItem{}](#__struct__/0)

Fields

------

* title: A short title like 'Retry', 'Open Log' etc.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/message_action_item.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.MessageActionItem{title: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.MessageActionItem{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/message_action_item.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* title: A short title like 'Retry', 'Open Log' etc.





GenLSP.Structures.Moniker — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker.ex#L2 "View Source")

GenLSP.Structures.Moniker

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================

Moniker definition to match LSIF 0.5 moniker definition.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.Moniker{}](#__struct__/0)

Fields

------

* scheme: The scheme of the moniker. For example tsc or .Net

* identifier: The identifier of the moniker. The value is opaque in LSIF however

schema owners are allowed to define the structure if they want.

* unique: The scope in which the moniker is unique

* kind: The moniker kind if known.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.Moniker{

  identifier: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  kind: [GenLSP.Enumerations.MonikerKind.t](GenLSP.Enumerations.MonikerKind.html#t:t/0)() | nil,

  scheme: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  unique: [GenLSP.Enumerations.UniquenessLevel.t](GenLSP.Enumerations.UniquenessLevel.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.Moniker{}

============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* scheme: The scheme of the moniker. For example tsc or .Net

* identifier: The identifier of the moniker. The value is opaque in LSIF however

schema owners are allowed to define the structure if they want.

* unique: The scope in which the moniker is unique

* kind: The moniker kind if known.





GenLSP.Structures.MonikerClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.MonikerClientCapabilities

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================

Client capabilities specific to the moniker request.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.MonikerClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether moniker supports dynamic registration. If this is set to `true`

the client supports the new `MonikerRegistrationOptions` return value

for the corresponding server capability as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_client_capabilities.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.MonikerClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.MonikerClientCapabilities{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_client_capabilities.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether moniker supports dynamic registration. If this is set to `true`

the client supports the new `MonikerRegistrationOptions` return value

for the corresponding server capability as well.





GenLSP.Structures.MonikerOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_options.ex#L2 "View Source")

GenLSP.Structures.MonikerOptions

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.MonikerOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_options.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.MonikerOptions{work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.MonikerOptions{}

===================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_options.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.MonikerParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_params.ex#L2 "View Source")

GenLSP.Structures.MonikerParams

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.MonikerParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_params.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.MonikerParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.MonikerParams{}

==================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_params.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.MonikerRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_registration_options.ex#L2 "View Source")

GenLSP.Structures.MonikerRegistrationOptions

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.MonikerRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_registration_options.ex#L14 "View Source")

```

@type t() :: %GenLSP.Structures.MonikerRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.MonikerRegistrationOptions{}

===============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/moniker_registration_options.ex#L14 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.NotebookCell — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_cell.ex#L2 "View Source")

GenLSP.Structures.NotebookCell

(gen\_lsp v0.6.0)

================================================================================================================================================================================================

A notebook cell.

A cell's document URI must be unique across ALL notebook

cells and can therefore be used to uniquely identify a

notebook cell or the cell's text document.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.NotebookCell{}](#__struct__/0)

Fields

------

* kind: The cell's kind

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_cell.ex#L30 "View Source")

```

@type t() :: %GenLSP.Structures.NotebookCell{

  document: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)(),

  execution_summary: [GenLSP.Structures.ExecutionSummary.t](GenLSP.Structures.ExecutionSummary.html#t:t/0)() | nil,

  kind: [GenLSP.Enumerations.NotebookCellKind.t](GenLSP.Enumerations.NotebookCellKind.html#t:t/0)(),

  metadata: [GenLSP.TypeAlias.LSPObject.t](GenLSP.TypeAlias.LSPObject.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.NotebookCell{}

=================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_cell.ex#L30 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* kind: The cell's kind

* document: The URI of the cell's text document

content.

* metadata: Additional metadata stored with the cell.

Note: should always be an object literal (e.g. LSPObject)

* execution\_summary: Additional execution summary information

if supported by the client.





GenLSP.Structures.NotebookCellArrayChange — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_cell_array_change.ex#L2 "View Source")

GenLSP.Structures.NotebookCellArrayChange

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================

A change describing how to move a `NotebookCell`

array from state S to S'.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.NotebookCellArrayChange{}](#__struct__/0)

Fields

------

* start: The start oftest of the cell that changed.

* delete\_count: The deleted cells

* cells: The new cells, if any

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_cell_array_change.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.NotebookCellArrayChange{

  cells: [[GenLSP.Structures.NotebookCell.t](GenLSP.Structures.NotebookCell.html#t:t/0)()] | nil,

  delete_count: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)(),

  start: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.NotebookCellArrayChange{}

============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_cell_array_change.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* start: The start oftest of the cell that changed.

* delete\_count: The deleted cells

* cells: The new cells, if any





GenLSP.Structures.NotebookCellTextDocumentFilter — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_cell_text_document_filter.ex#L2 "View Source")

GenLSP.Structures.NotebookCellTextDocumentFilter

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================================

A notebook cell text document filter denotes a cell text

document by different properties.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.NotebookCellTextDocumentFilter{}](#__struct__/0)

Fields

------

* notebook: A filter that matches against the notebook

containing the notebook cell. If a string

value is provided it matches against the

notebook type. '\*' matches every notebook.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_cell_text_document_filter.ex#L27 "View Source")

```

@type t() :: %GenLSP.Structures.NotebookCellTextDocumentFilter{

  language: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  notebook: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | [GenLSP.TypeAlias.NotebookDocumentFilter.t](GenLSP.TypeAlias.NotebookDocumentFilter.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.NotebookCellTextDocumentFilter{}

===================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_cell_text_document_filter.ex#L27 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* notebook: A filter that matches against the notebook

containing the notebook cell. If a string

value is provided it matches against the

notebook type. '\*' matches every notebook.

* language: A language id like `python`.

Will be matched against the language id of the

notebook cell document. '\*' matches every language.





GenLSP.Structures.NotebookDocument — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document.ex#L2 "View Source")

GenLSP.Structures.NotebookDocument

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================

A notebook document.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.NotebookDocument{}](#__struct__/0)

Fields

------

* uri: The notebook document's uri.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document.ex#L27 "View Source")

```

@type t() :: %GenLSP.Structures.NotebookDocument{

  cells: [[GenLSP.Structures.NotebookCell.t](GenLSP.Structures.NotebookCell.html#t:t/0)()],

  metadata: [GenLSP.TypeAlias.LSPObject.t](GenLSP.TypeAlias.LSPObject.html#t:t/0)() | nil,

  notebook_type: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  uri: [GenLSP.BaseTypes.uri](GenLSP.BaseTypes.html#t:uri/0)(),

  version: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.NotebookDocument{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document.ex#L27 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: The notebook document's uri.

* notebook\_type: The type of the notebook.

* version: The version number of this document (it will increase after each

change, including undo/redo).

* metadata: Additional metadata stored with the notebook

document.

Note: should always be an object literal (e.g. LSPObject)

* cells: The cells of a notebook.





GenLSP.Structures.NotebookDocumentChangeEvent — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_change_event.ex#L2 "View Source")

GenLSP.Structures.NotebookDocumentChangeEvent

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================

A change event for a notebook document.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.NotebookDocumentChangeEvent{}](#__struct__/0)

Fields

------

* metadata: The changed meta data if any.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_change_event.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.NotebookDocumentChangeEvent{

  cells: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  metadata: [GenLSP.TypeAlias.LSPObject.t](GenLSP.TypeAlias.LSPObject.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.NotebookDocumentChangeEvent{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_change_event.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* metadata: The changed meta data if any.

Note: should always be an object literal (e.g. LSPObject)

* cells: Changes to cells





GenLSP.Structures.NotebookDocumentClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.NotebookDocumentClientCapabilities

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================================

Capabilities specific to the notebook document support.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.NotebookDocumentClientCapabilities{}](#__struct__/0)

Fields

------

* synchronization: Capabilities specific to notebook document synchronization

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_client_capabilities.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.NotebookDocumentClientCapabilities{

  synchronization: [GenLSP.Structures.NotebookDocumentSyncClientCapabilities.t](GenLSP.Structures.NotebookDocumentSyncClientCapabilities.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.NotebookDocumentClientCapabilities{}

=======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_client_capabilities.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* synchronization: Capabilities specific to notebook document synchronization

@since 3.17.0





GenLSP.Structures.NotebookDocumentIdentifier — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_identifier.ex#L2 "View Source")

GenLSP.Structures.NotebookDocumentIdentifier

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================================

A literal to identify a notebook document in the client.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.NotebookDocumentIdentifier{}](#__struct__/0)

Fields

------

* uri: The notebook document's uri.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_identifier.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.NotebookDocumentIdentifier{

  uri: [GenLSP.BaseTypes.uri](GenLSP.BaseTypes.html#t:uri/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.NotebookDocumentIdentifier{}

===============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_identifier.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: The notebook document's uri.





GenLSP.Structures.NotebookDocumentSyncClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_sync_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.NotebookDocumentSyncClientCapabilities

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================================================

Notebook specific client capabilities.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.NotebookDocumentSyncClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is

set to `true` the client supports the new

`(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.

* execution\_summary\_support: The client supports sending execution summary data per cell.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_sync_client_capabilities.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.NotebookDocumentSyncClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  execution_summary_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.NotebookDocumentSyncClientCapabilities{}

===========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_sync_client_capabilities.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is

set to `true` the client supports the new

`(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.

* execution\_summary\_support: The client supports sending execution summary data per cell.





GenLSP.Structures.NotebookDocumentSyncOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_sync_options.ex#L2 "View Source")

GenLSP.Structures.NotebookDocumentSyncOptions

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================

Options specific to a notebook plus its cells

to be synced to the server.

If a selector provides a notebook document

filter but no cell selector all cells of a

matching notebook document will be synced.

If a selector provides no notebook document

filter but only a cell selector all notebook

document that contain at least one matching

cell will be synced.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.NotebookDocumentSyncOptions{}](#__struct__/0)

Fields

------

* notebook\_selector: The notebooks to be synced

* save: Whether save notification should be forwarded to

the server. Will only be honored if mode === `notebook`.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_sync_options.ex#L31 "View Source")

```

@type t() :: %GenLSP.Structures.NotebookDocumentSyncOptions{

  notebook_selector: [[map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)()],

  save: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.NotebookDocumentSyncOptions{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_sync_options.ex#L31 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* notebook\_selector: The notebooks to be synced

* save: Whether save notification should be forwarded to

the server. Will only be honored if mode === `notebook`.





GenLSP.Structures.NotebookDocumentSyncRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_sync_registration_options.ex#L2 "View Source")

GenLSP.Structures.NotebookDocumentSyncRegistrationOptions

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================================================

Registration options specific to a notebook.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.NotebookDocumentSyncRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* notebook\_selector: The notebooks to be synced

* save: Whether save notification should be forwarded to

the server. Will only be honored if mode === `notebook`.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_sync_registration_options.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.NotebookDocumentSyncRegistrationOptions{

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  notebook_selector: [[map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)()],

  save: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.NotebookDocumentSyncRegistrationOptions{}

============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/notebook_document_sync_registration_options.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* notebook\_selector: The notebooks to be synced

* save: Whether save notification should be forwarded to

the server. Will only be honored if mode === `notebook`.





GenLSP.Structures.OptionalVersionedTextDocumentIdentifier — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/optional_versioned_text_document_identifier.ex#L2 "View Source")

GenLSP.Structures.OptionalVersionedTextDocumentIdentifier

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================================================

A text document identifier to optionally denote a specific version of a text document.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.OptionalVersionedTextDocumentIdentifier{}](#__struct__/0)

Fields

------

* version: The version number of this document. If a versioned text document identifier

is sent from the server to the client and the file is not open in the editor

(the server has not received an open notification before) the server can send

`null` to indicate that the version is unknown and the content on disk is the

truth (as specified with document content ownership).

* uri: The text document's uri.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/optional_versioned_text_document_identifier.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.OptionalVersionedTextDocumentIdentifier{

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)(),

  version: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.OptionalVersionedTextDocumentIdentifier{}

============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/optional_versioned_text_document_identifier.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* version: The version number of this document. If a versioned text document identifier

is sent from the server to the client and the file is not open in the editor

(the server has not received an open notification before) the server can send

`null` to indicate that the version is unknown and the content on disk is the

truth (as specified with document content ownership).

* uri: The text document's uri.





GenLSP.Structures.ParameterInformation — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/parameter_information.ex#L2 "View Source")

GenLSP.Structures.ParameterInformation

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================

Represents a parameter of a callable-signature. A parameter can

have a label and a doc-comment.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ParameterInformation{}](#__struct__/0)

Fields

------

* label: The label of this parameter information.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/parameter_information.ex#L27 "View Source")

```

@type t() :: %GenLSP.Structures.ParameterInformation{

  documentation: ([String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | [GenLSP.Structures.MarkupContent.t](GenLSP.Structures.MarkupContent.html#t:t/0)()) | nil,

  label: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | {[GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)(), [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)()}

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ParameterInformation{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/parameter_information.ex#L27 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* label: The label of this parameter information.

Either a string or an inclusive start and exclusive end offsets within its containing

signature label. (see SignatureInformation.label). The offsets are based on a UTF-16

string representation as `Position` and [`Range`](https://hexdocs.pm/elixir/Range.html) does.

*Note*: a label of type string should be a substring of its containing signature label.

Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.

* documentation: The human-readable doc-comment of this parameter. Will be shown

in the UI but can be omitted.





GenLSP.Structures.PartialResultParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/partial_result_params.ex#L2 "View Source")

GenLSP.Structures.PartialResultParams

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.PartialResultParams{}](#__struct__/0)

Fields

------

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/partial_result_params.ex#L14 "View Source")

```

@type t() :: %GenLSP.Structures.PartialResultParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.PartialResultParams{}

========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/partial_result_params.ex#L14 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.Position — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/position.ex#L2 "View Source")

GenLSP.Structures.Position

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================

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`](#clientCapabilities).

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`](#serverCapabilities). 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.

Positions are line end character agnostic. So you can not specify a position

that denotes `|` or `|` where `|` represents the character offset.

@since 3.17.0 - support for negotiated position encoding.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.Position{}](#__struct__/0)

Fields

------

* line: Line position in a document (zero-based).

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/position.ex#L53 "View Source")

```

@type t() :: %GenLSP.Structures.Position{

  character: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)(),

  line: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.Position{}

=============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/position.ex#L53 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* line: Line position in a document (zero-based).

If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document.

If a line number is negative, it defaults to 0.

* character: Character offset on a line in a document (zero-based).

The meaning of this offset is determined by the negotiated

`PositionEncodingKind`.

If the character value is greater than the line length it defaults back to the

line length.





GenLSP.Structures.PrepareRenameParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/prepare_rename_params.ex#L2 "View Source")

GenLSP.Structures.PrepareRenameParams

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.PrepareRenameParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/prepare_rename_params.ex#L15 "View Source")

```

@type t() :: %GenLSP.Structures.PrepareRenameParams{

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.PrepareRenameParams{}

========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/prepare_rename_params.ex#L15 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.PreviousResultId — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/previous_result_id.ex#L2 "View Source")

GenLSP.Structures.PreviousResultId

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

A previous result id in a workspace pull request.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.PreviousResultId{}](#__struct__/0)

Fields

------

* uri: The URI for which the client knowns a

result id.

* value: The value of the previous result id.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/previous_result_id.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.PreviousResultId{

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)(),

  value: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.PreviousResultId{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/previous_result_id.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: The URI for which the client knowns a

result id.

* value: The value of the previous result id.





GenLSP.Structures.PrivateInitializeParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/private_initialize_params.ex#L2 "View Source")

GenLSP.Structures.PrivateInitializeParams

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================

The initialize parameters

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.PrivateInitializeParams{}](#__struct__/0)

Fields

------

* process\_id: The process Id of the parent process that started

the server.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/private_initialize_params.ex#L45 "View Source")

```

@type t() :: %GenLSP.Structures.PrivateInitializeParams{

  capabilities: [GenLSP.Structures.ClientCapabilities.t](GenLSP.Structures.ClientCapabilities.html#t:t/0)(),

  client_info: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  initialization_options: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  locale: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  process_id: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  root_path: ([String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil) | nil,

  root_uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)() | nil,

  trace: [GenLSP.Enumerations.TraceValues.t](GenLSP.Enumerations.TraceValues.html#t:t/0)() | nil,

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.PrivateInitializeParams{}

============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/private_initialize_params.ex#L45 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* process\_id: The process Id of the parent process that started

the server.

Is `null` if the process has not been started by another process.

If the parent process is not alive then the server should exit.

* client\_info: Information about the client

@since 3.15.0

* locale: The locale the client is currently showing the user interface

in. This must not necessarily be the locale of the operating

system.

Uses IETF language tags as the value's syntax

(See <https://en.wikipedia.org/wiki/IETF_language_tag>)

@since 3.16.0

* root\_path: The rootPath of the workspace. Is null

if no folder is open.

@deprecated in favour of rootUri.

* root\_uri: The rootUri of the workspace. Is null if no

folder is open. If both `rootPath` and `rootUri` are set

`rootUri` wins.

@deprecated in favour of workspaceFolders.

* capabilities: The capabilities provided by the client (editor or tool)

* initialization\_options: User provided initialization options.

* trace: The initial trace setting. If omitted trace is disabled ('off').

* work\_done\_token: An optional token that a server can use to report work done progress.





GenLSP.Structures.ProgressParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/progress_params.ex#L2 "View Source")

GenLSP.Structures.ProgressParams

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ProgressParams{}](#__struct__/0)

Fields

------

* token: The progress token provided by the client or server.

* value: The progress data.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/progress_params.ex#L14 "View Source")

```

@type t() :: %GenLSP.Structures.ProgressParams{

  token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)(),

  value: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ProgressParams{}

===================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/progress_params.ex#L14 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* token: The progress token provided by the client or server.

* value: The progress data.





GenLSP.Structures.PublishDiagnosticsClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/publish_diagnostics_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.PublishDiagnosticsClientCapabilities

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================================

The publish diagnostic client capabilities.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.PublishDiagnosticsClientCapabilities{}](#__struct__/0)

Fields

------

* related\_information: Whether the clients accepts diagnostics with related information.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/publish_diagnostics_client_capabilities.ex#L33 "View Source")

```

@type t() :: %GenLSP.Structures.PublishDiagnosticsClientCapabilities{

  code_description_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  data_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  related_information: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  tag_support: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  version_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.PublishDiagnosticsClientCapabilities{}

=========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/publish_diagnostics_client_capabilities.ex#L33 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* related\_information: Whether the clients accepts diagnostics with related information.

* tag\_support: Client supports the tag property to provide meta data about a diagnostic.

Clients supporting tags have to handle unknown tags gracefully.

@since 3.15.0

* version\_support: Whether the client interprets the version property of the

`textDocument/publishDiagnostics` notification's parameter.

@since 3.15.0

* code\_description\_support: Client supports a codeDescription property

@since 3.16.0

* data\_support: Whether code action supports the `data` property which is

preserved between a `textDocument/publishDiagnostics` and

`textDocument/codeAction` request.

@since 3.16.0





GenLSP.Structures.PublishDiagnosticsParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/publish_diagnostics_params.ex#L2 "View Source")

GenLSP.Structures.PublishDiagnosticsParams

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================

The publish diagnostic notification's parameters.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.PublishDiagnosticsParams{}](#__struct__/0)

Fields

------

* uri: The URI for which diagnostic information is reported.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/publish_diagnostics_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.PublishDiagnosticsParams{

  diagnostics: [[GenLSP.Structures.Diagnostic.t](GenLSP.Structures.Diagnostic.html#t:t/0)()],

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)(),

  version: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.PublishDiagnosticsParams{}

=============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/publish_diagnostics_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: The URI for which diagnostic information is reported.

* version: Optional the version number of the document the diagnostics are published for.

@since 3.15.0

* diagnostics: An array of diagnostic information items.





GenLSP.Structures.Range — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/range.ex#L2 "View Source")

GenLSP.Structures.Range

(gen\_lsp v0.6.0)

=================================================================================================================================================================================

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

If you want to specify a range that contains a line including the line ending

character(s) then use an end position denoting the start of the next line.

For example:

```

{

    start: { line: 5, character: 23 }

    end : { line 6, character : 0 }

}

```

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.Range{}](#__struct__/0)

Fields

------

* start: The range's start position.

* end: The range's end position.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/range.ex#L28 "View Source")

```

@type t() :: %GenLSP.Structures.Range{

  end: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  start: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.Range{}

==========================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/range.ex#L28 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* start: The range's start position.

* end: The range's end position.





GenLSP.Structures.ReferenceClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.ReferenceClientCapabilities

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================================

Client Capabilities for a {@link ReferencesRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ReferenceClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether references supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_client_capabilities.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.ReferenceClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ReferenceClientCapabilities{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_client_capabilities.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether references supports dynamic registration.





GenLSP.Structures.ReferenceContext — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_context.ex#L2 "View Source")

GenLSP.Structures.ReferenceContext

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================

Value-object that contains additional information when

requesting references.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ReferenceContext{}](#__struct__/0)

Fields

------

* include\_declaration: Include the declaration of the current symbol.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_context.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.ReferenceContext{include_declaration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ReferenceContext{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_context.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* include\_declaration: Include the declaration of the current symbol.





GenLSP.Structures.ReferenceOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_options.ex#L2 "View Source")

GenLSP.Structures.ReferenceOptions

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================

Reference options.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ReferenceOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_options.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.ReferenceOptions{work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ReferenceOptions{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_options.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.ReferenceParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_params.ex#L2 "View Source")

GenLSP.Structures.ReferenceParams

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================

Parameters for a {@link ReferencesRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ReferenceParams{}](#__struct__/0)

Fields

------

* context

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_params.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.ReferenceParams{

  context: [GenLSP.Structures.ReferenceContext.t](GenLSP.Structures.ReferenceContext.html#t:t/0)(),

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ReferenceParams{}

====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_params.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* context

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.ReferenceRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_registration_options.ex#L2 "View Source")

GenLSP.Structures.ReferenceRegistrationOptions

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================================

Registration options for a {@link ReferencesRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ReferenceRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_registration_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.ReferenceRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ReferenceRegistrationOptions{}

=================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/reference_registration_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.Registration — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/registration.ex#L2 "View Source")

GenLSP.Structures.Registration

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================

General parameters to register for a notification or to register a provider.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.Registration{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again.

* method: The method / capability to register for.

* register\_options: Options necessary for the registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/registration.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.Registration{

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  register_options: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.Registration{}

=================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/registration.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again.

* method: The method / capability to register for.

* register\_options: Options necessary for the registration.





GenLSP.Structures.RegistrationParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/registration_params.ex#L2 "View Source")

GenLSP.Structures.RegistrationParams

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RegistrationParams{}](#__struct__/0)

Fields

------

* registrations

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/registration_params.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.RegistrationParams{

  registrations: [[GenLSP.Structures.Registration.t](GenLSP.Structures.Registration.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RegistrationParams{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/registration_params.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* registrations





GenLSP.Structures.RegularExpressionsClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/regular_expressions_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.RegularExpressionsClientCapabilities

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================================================================

Client capabilities specific to regular expressions.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RegularExpressionsClientCapabilities{}](#__struct__/0)

Fields

------

* engine: The engine's name.

* version: The engine's version.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/regular_expressions_client_capabilities.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.RegularExpressionsClientCapabilities{

  engine: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  version: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RegularExpressionsClientCapabilities{}

=========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/regular_expressions_client_capabilities.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* engine: The engine's name.

* version: The engine's version.





GenLSP.Structures.RelatedFullDocumentDiagnosticReport — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/related_full_document_diagnostic_report.ex#L2 "View Source")

GenLSP.Structures.RelatedFullDocumentDiagnosticReport

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================================================

A full diagnostic report with a set of related documents.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RelatedFullDocumentDiagnosticReport{}](#__struct__/0)

Fields

------

* related\_documents: Diagnostics of related documents. This information is useful

in programming languages where code in a file A can generate

diagnostics in a file B which A depends on. An example of

such a language is C/C++ where marco definitions in a file

a.cpp and result in errors in a header file b.hpp.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/related_full_document_diagnostic_report.ex#L30 "View Source")

```

@type t() :: %GenLSP.Structures.RelatedFullDocumentDiagnosticReport{

  items: [[GenLSP.Structures.Diagnostic.t](GenLSP.Structures.Diagnostic.html#t:t/0)()],

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  related_documents:

    %{

      required([GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()) =>

        [GenLSP.Structures.FullDocumentDiagnosticReport.t](GenLSP.Structures.FullDocumentDiagnosticReport.html#t:t/0)()

        | [GenLSP.Structures.UnchangedDocumentDiagnosticReport.t](GenLSP.Structures.UnchangedDocumentDiagnosticReport.html#t:t/0)()

    }

    | nil,

  result_id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RelatedFullDocumentDiagnosticReport{}

========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/related_full_document_diagnostic_report.ex#L30 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* related\_documents: Diagnostics of related documents. This information is useful

in programming languages where code in a file A can generate

diagnostics in a file B which A depends on. An example of

such a language is C/C++ where marco definitions in a file

a.cpp and result in errors in a header file b.hpp.

@since 3.17.0

* kind: A full document diagnostic report.

* result\_id: An optional result id. If provided it will

be sent on the next diagnostic request for the

same document.

* items: The actual items.





GenLSP.Structures.RelatedUnchangedDocumentDiagnosticReport — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/related_unchanged_document_diagnostic_report.ex#L2 "View Source")

GenLSP.Structures.RelatedUnchangedDocumentDiagnosticReport

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================================================

An unchanged diagnostic report with a set of related documents.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RelatedUnchangedDocumentDiagnosticReport{}](#__struct__/0)

Fields

------

* related\_documents: Diagnostics of related documents. This information is useful

in programming languages where code in a file A can generate

diagnostics in a file B which A depends on. An example of

such a language is C/C++ where marco definitions in a file

a.cpp and result in errors in a header file b.hpp.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/related_unchanged_document_diagnostic_report.ex#L31 "View Source")

```

@type t() :: %GenLSP.Structures.RelatedUnchangedDocumentDiagnosticReport{

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  related_documents:

    %{

      required([GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()) =>

        [GenLSP.Structures.FullDocumentDiagnosticReport.t](GenLSP.Structures.FullDocumentDiagnosticReport.html#t:t/0)()

        | [GenLSP.Structures.UnchangedDocumentDiagnosticReport.t](GenLSP.Structures.UnchangedDocumentDiagnosticReport.html#t:t/0)()

    }

    | nil,

  result_id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RelatedUnchangedDocumentDiagnosticReport{}

=============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/related_unchanged_document_diagnostic_report.ex#L31 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* related\_documents: Diagnostics of related documents. This information is useful

in programming languages where code in a file A can generate

diagnostics in a file B which A depends on. An example of

such a language is C/C++ where marco definitions in a file

a.cpp and result in errors in a header file b.hpp.

@since 3.17.0

* kind: A document diagnostic report indicating

no changes to the last result. A server can

only return `unchanged` if result ids are

provided.

* result\_id: A result id which will be sent on the next

diagnostic request for the same document.





GenLSP.Structures.RelativePattern — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/relative_pattern.ex#L2 "View Source")

GenLSP.Structures.RelativePattern

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================

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.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RelativePattern{}](#__struct__/0)

Fields

------

* base\_uri: A workspace folder or a base URI to which this pattern will be matched

against relatively.

* pattern: The actual glob pattern;

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/relative_pattern.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.RelativePattern{

  base_uri: [GenLSP.Structures.WorkspaceFolder.t](GenLSP.Structures.WorkspaceFolder.html#t:t/0)() | [GenLSP.BaseTypes.uri](GenLSP.BaseTypes.html#t:uri/0)(),

  pattern: [GenLSP.TypeAlias.Pattern.t](GenLSP.TypeAlias.Pattern.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RelativePattern{}

====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/relative_pattern.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* base\_uri: A workspace folder or a base URI to which this pattern will be matched

against relatively.

* pattern: The actual glob pattern;





GenLSP.Structures.RenameClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.RenameClientCapabilities

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RenameClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether rename supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_client_capabilities.ex#L30 "View Source")

```

@type t() :: %GenLSP.Structures.RenameClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  honors_change_annotations: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  prepare_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  prepare_support_default_behavior:

    [GenLSP.Enumerations.PrepareSupportDefaultBehavior.t](GenLSP.Enumerations.PrepareSupportDefaultBehavior.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RenameClientCapabilities{}

=============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_client_capabilities.ex#L30 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether rename supports dynamic registration.

* prepare\_support: Client supports testing for validity of rename operations

before execution.

@since 3.12.0

* prepare\_support\_default\_behavior: Client supports the default behavior result.

The value indicates the default behavior used by the

client.

@since 3.16.0

* honors\_change\_annotations: Whether the client honors the change annotations in

text edits and resource operations returned via the

rename request's workspace edit by for example presenting

the workspace edit in the user interface and asking

for confirmation.

@since 3.16.0





GenLSP.Structures.RenameFile — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_file.ex#L2 "View Source")

GenLSP.Structures.RenameFile

(gen\_lsp v0.6.0)

============================================================================================================================================================================================

Rename file operation

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RenameFile{}](#__struct__/0)

Fields

------

* kind: A rename

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_file.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.RenameFile{

  annotation_id: [GenLSP.TypeAlias.ChangeAnnotationIdentifier.t](GenLSP.TypeAlias.ChangeAnnotationIdentifier.html#t:t/0)() | nil,

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  new_uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)(),

  old_uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)(),

  options: [GenLSP.Structures.RenameFileOptions.t](GenLSP.Structures.RenameFileOptions.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RenameFile{}

===============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_file.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* kind: A rename

* old\_uri: The old (existing) location.

* new\_uri: The new location.

* options: Rename options.

* annotation\_id: An optional annotation identifier describing the operation.

@since 3.16.0





GenLSP.Structures.RenameFileOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_file_options.ex#L2 "View Source")

GenLSP.Structures.RenameFileOptions

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

Rename file options

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RenameFileOptions{}](#__struct__/0)

Fields

------

* overwrite: Overwrite target if existing. Overwrite wins over `ignoreIfExists`

* ignore\_if\_exists: Ignores if target exists.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_file_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.RenameFileOptions{

  ignore_if_exists: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  overwrite: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RenameFileOptions{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_file_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* overwrite: Overwrite target if existing. Overwrite wins over `ignoreIfExists`

* ignore\_if\_exists: Ignores if target exists.





GenLSP.Structures.RenameFilesParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_files_params.ex#L2 "View Source")

GenLSP.Structures.RenameFilesParams

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

The parameters sent in notifications/requests for user-initiated renames of

files.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RenameFilesParams{}](#__struct__/0)

Fields

------

* files: An array of all files/folders renamed in this operation. When a folder is renamed, only

the folder will be included, and not its children.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_files_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.RenameFilesParams{

  files: [[GenLSP.Structures.FileRename.t](GenLSP.Structures.FileRename.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RenameFilesParams{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_files_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* files: An array of all files/folders renamed in this operation. When a folder is renamed, only

the folder will be included, and not its children.





GenLSP.Structures.RenameOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_options.ex#L2 "View Source")

GenLSP.Structures.RenameOptions

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================

Provider options for a {@link RenameRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RenameOptions{}](#__struct__/0)

Fields

------

* prepare\_provider: Renames should be checked and tested before being executed.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_options.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.RenameOptions{

  prepare_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RenameOptions{}

==================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_options.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* prepare\_provider: Renames should be checked and tested before being executed.

@since version 3.12.0

* work\_done\_progress





GenLSP.Structures.RenameParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_params.ex#L2 "View Source")

GenLSP.Structures.RenameParams

(gen\_lsp v0.6.0)

================================================================================================================================================================================================

The parameters of a {@link RenameRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RenameParams{}](#__struct__/0)

Fields

------

* text\_document: The document to rename.

* position: The position at which this request was sent.

* new\_name: The new name of the symbol. If the given name is not valid the

request must return a {@link ResponseError} with an

appropriate message set.

* work\_done\_token: An optional token that a server can use to report work done progress.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_params.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.RenameParams{

  new_name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RenameParams{}

=================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_params.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document to rename.

* position: The position at which this request was sent.

* new\_name: The new name of the symbol. If the given name is not valid the

request must return a {@link ResponseError} with an

appropriate message set.

* work\_done\_token: An optional token that a server can use to report work done progress.





GenLSP.Structures.RenameRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_registration_options.ex#L2 "View Source")

GenLSP.Structures.RenameRegistrationOptions

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================

Registration options for a {@link RenameRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.RenameRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_registration_options.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.RenameRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  prepare_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.RenameRegistrationOptions{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/rename_registration_options.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* prepare\_provider: Renames should be checked and tested before being executed.

@since version 3.12.0





GenLSP.Structures.ResourceOperation — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/resource_operation.ex#L2 "View Source")

GenLSP.Structures.ResourceOperation

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

A generic resource operation.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ResourceOperation{}](#__struct__/0)

Fields

------

* kind: The resource operation kind.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/resource_operation.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.ResourceOperation{

  annotation_id: [GenLSP.TypeAlias.ChangeAnnotationIdentifier.t](GenLSP.TypeAlias.ChangeAnnotationIdentifier.html#t:t/0)() | nil,

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ResourceOperation{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/resource_operation.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* kind: The resource operation kind.

* annotation\_id: An optional annotation identifier describing the operation.

@since 3.16.0





GenLSP.Structures.SaveOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/save_options.ex#L2 "View Source")

GenLSP.Structures.SaveOptions

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================

Save options.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SaveOptions{}](#__struct__/0)

Fields

------

* include\_text: The client is supposed to include the content on save.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/save_options.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.SaveOptions{include_text: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SaveOptions{}

================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/save_options.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* include\_text: The client is supposed to include the content on save.





GenLSP.Structures.SelectionRange — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range.ex#L2 "View Source")

GenLSP.Structures.SelectionRange

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================

A selection range represents a part of a selection hierarchy. A selection range

may have a parent selection range that contains it.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SelectionRange{}](#__struct__/0)

Fields

------

* range: The {@link Range range} of this selection range.

* parent: The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.SelectionRange{

  parent: [t](#t:t/0)() | nil,

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SelectionRange{}

===================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* range: The {@link Range range} of this selection range.

* parent: The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.





GenLSP.Structures.SelectionRangeClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.SelectionRangeClientCapabilities

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SelectionRangeClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration for selection range providers. If this is set to `true`

the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server

capability as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_client_capabilities.ex#L15 "View Source")

```

@type t() :: %GenLSP.Structures.SelectionRangeClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SelectionRangeClientCapabilities{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_client_capabilities.ex#L15 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration for selection range providers. If this is set to `true`

the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server

capability as well.





GenLSP.Structures.SelectionRangeOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_options.ex#L2 "View Source")

GenLSP.Structures.SelectionRangeOptions

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SelectionRangeOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_options.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.SelectionRangeOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SelectionRangeOptions{}

==========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_options.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.SelectionRangeParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_params.ex#L2 "View Source")

GenLSP.Structures.SelectionRangeParams

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

A parameter literal used in selection range requests.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SelectionRangeParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* positions: The positions inside the text document.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.SelectionRangeParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  positions: [[GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)()],

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SelectionRangeParams{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* positions: The positions inside the text document.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.SelectionRangeRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_registration_options.ex#L2 "View Source")

GenLSP.Structures.SelectionRangeRegistrationOptions

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SelectionRangeRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_registration_options.ex#L16 "View Source")

```

@type t() :: %GenLSP.Structures.SelectionRangeRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SelectionRangeRegistrationOptions{}

======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/selection_range_registration_options.ex#L16 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.SemanticTokens — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens.ex#L2 "View Source")

GenLSP.Structures.SemanticTokens

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokens{}](#__struct__/0)

Fields

------

* result\_id: An optional result id. If provided and clients support delta updating

the client will include the result id in the next semantic token request.

A server can then instead of computing all semantic tokens again simply

send a delta.

* data: The actual tokens.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokens{

  data: [[GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)()],

  result_id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokens{}

===================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* result\_id: An optional result id. If provided and clients support delta updating

the client will include the result id in the next semantic token request.

A server can then instead of computing all semantic tokens again simply

send a delta.

* data: The actual tokens.





GenLSP.Structures.SemanticTokensClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensClientCapabilities

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_client_capabilities.ex#L48 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensClientCapabilities{

  augments_syntax_tokens: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  formats: [[GenLSP.Enumerations.TokenFormat.t](GenLSP.Enumerations.TokenFormat.html#t:t/0)()],

  multiline_token_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  overlapping_token_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  requests: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  server_cancel_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  token_modifiers: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()],

  token_types: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensClientCapabilities{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_client_capabilities.ex#L48 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.

* requests: Which requests the client supports and might send to the server

depending on the server's capability. Please note that clients might not

show semantic tokens or degrade some of the user experience if a range

or full request is advertised by the client but not provided by the

server. If for example the client capability `requests.full` and

`request.range` are both set to true but the server only provides a

range provider the client might not render a minimap correctly or might

even decide to not show any semantic tokens at all.

* token\_types: The token types that the client supports.

* token\_modifiers: The token modifiers that the client supports.

* formats: The token formats the clients supports.

* overlapping\_token\_support: Whether the client supports tokens that can overlap each other.

* multiline\_token\_support: Whether the client supports tokens that can span multiple lines.

* server\_cancel\_support: Whether the client allows the server to actively cancel a

semantic token request, e.g. supports returning

LSPErrorCodes.ServerCancelled. If a server does the client

needs to retrigger the request.

@since 3.17.0

* augments\_syntax\_tokens: Whether the client uses semantic tokens to augment existing

syntax tokens. If set to `true` client side created syntax

tokens and semantic tokens are both used for colorization. If

set to `false` the client only uses the returned semantic tokens

for colorization.

If the value is `undefined` then the client behavior is not

specified.

@since 3.17.0





GenLSP.Structures.SemanticTokensDelta — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_delta.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensDelta

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensDelta{}](#__struct__/0)

Fields

------

* result\_id

* edits: The semantic token edits to transform a previous result into a new result.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_delta.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensDelta{

  edits: [[GenLSP.Structures.SemanticTokensEdit.t](GenLSP.Structures.SemanticTokensEdit.html#t:t/0)()],

  result_id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensDelta{}

========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_delta.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* result\_id

* edits: The semantic token edits to transform a previous result into a new result.





GenLSP.Structures.SemanticTokensDeltaParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_delta_params.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensDeltaParams

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensDeltaParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* previous\_result\_id: The result id of a previous response. The result Id can either point to a full response

or a delta response depending on what was received last.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_delta_params.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensDeltaParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  previous_result_id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensDeltaParams{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_delta_params.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* previous\_result\_id: The result id of a previous response. The result Id can either point to a full response

or a delta response depending on what was received last.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.SemanticTokensDeltaPartialResult — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_delta_partial_result.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensDeltaPartialResult

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensDeltaPartialResult{}](#__struct__/0)

Fields

------

* edits

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_delta_partial_result.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensDeltaPartialResult{

  edits: [[GenLSP.Structures.SemanticTokensEdit.t](GenLSP.Structures.SemanticTokensEdit.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensDeltaPartialResult{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_delta_partial_result.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* edits





GenLSP.Structures.SemanticTokensEdit — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_edit.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensEdit

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensEdit{}](#__struct__/0)

Fields

------

* start: The start offset of the edit.

* delete\_count: The count of elements to remove.

* data: The elements to insert.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_edit.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensEdit{

  data: [[GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)()] | nil,

  delete_count: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)(),

  start: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensEdit{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_edit.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* start: The start offset of the edit.

* delete\_count: The count of elements to remove.

* data: The elements to insert.





GenLSP.Structures.SemanticTokensLegend — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_legend.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensLegend

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensLegend{}](#__struct__/0)

Fields

------

* token\_types: The token types a server uses.

* token\_modifiers: The token modifiers a server uses.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_legend.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensLegend{

  token_modifiers: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()],

  token_types: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensLegend{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_legend.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* token\_types: The token types a server uses.

* token\_modifiers: The token modifiers a server uses.





GenLSP.Structures.SemanticTokensOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_options.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensOptions

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensOptions{}](#__struct__/0)

Fields

------

* legend: The legend used by the server

* range: Server supports providing semantic tokens for a specific range

of a document.

* full: Server supports providing semantic tokens for a full document.

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_options.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensOptions{

  full: ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)()) | nil,

  legend: [GenLSP.Structures.SemanticTokensLegend.t](GenLSP.Structures.SemanticTokensLegend.html#t:t/0)(),

  range: ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)()) | nil,

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensOptions{}

==========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_options.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* legend: The legend used by the server

* range: Server supports providing semantic tokens for a specific range

of a document.

* full: Server supports providing semantic tokens for a full document.

* work\_done\_progress





GenLSP.Structures.SemanticTokensParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_params.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensParams

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_params.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensParams{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_params.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.SemanticTokensPartialResult — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_partial_result.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensPartialResult

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensPartialResult{}](#__struct__/0)

Fields

------

* data

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_partial_result.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensPartialResult{

  data: [[GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensPartialResult{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_partial_result.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* data





GenLSP.Structures.SemanticTokensRangeParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_range_params.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensRangeParams

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensRangeParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* range: The range the semantic tokens are requested for.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_range_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensRangeParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensRangeParams{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_range_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* range: The range the semantic tokens are requested for.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.SemanticTokensRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_registration_options.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensRegistrationOptions

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* legend: The legend used by the server

* range: Server supports providing semantic tokens for a specific range

of a document.

* full: Server supports providing semantic tokens for a full document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_registration_options.ex#L24 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  full: ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)()) | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  legend: [GenLSP.Structures.SemanticTokensLegend.t](GenLSP.Structures.SemanticTokensLegend.html#t:t/0)(),

  range: ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)()) | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensRegistrationOptions{}

======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_registration_options.ex#L24 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* legend: The legend used by the server

* range: Server supports providing semantic tokens for a specific range

of a document.

* full: Server supports providing semantic tokens for a full document.





GenLSP.Structures.SemanticTokensWorkspaceClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_workspace_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.SemanticTokensWorkspaceClientCapabilities

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================================================================

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SemanticTokensWorkspaceClientCapabilities{}](#__struct__/0)

Fields

------

* refresh\_support: Whether the client implementation supports a refresh request sent from

the server to the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_workspace_client_capabilities.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.SemanticTokensWorkspaceClientCapabilities{

  refresh_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SemanticTokensWorkspaceClientCapabilities{}

==============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/semantic_tokens_workspace_client_capabilities.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* refresh\_support: Whether the client implementation supports a refresh request sent from

the server to the client.

Note that this event is global and will force the client to refresh all

semantic tokens currently shown. It should be used with absolute care

and is useful for situation where a server for example detects a project

wide change that requires such a calculation.





GenLSP.Structures.ServerCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/server_capabilities.ex#L2 "View Source")

GenLSP.Structures.ServerCapabilities

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================

Defines the capabilities provided by a language

server.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ServerCapabilities{}](#__struct__/0)

Fields

------

* position\_encoding: The position encoding the server picked from the encodings offered

by the client via the client capability `general.positionEncodings`.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/server_capabilities.ex#L84 "View Source")

```

@type t() :: %GenLSP.Structures.ServerCapabilities{

  call_hierarchy_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.CallHierarchyOptions.t](GenLSP.Structures.CallHierarchyOptions.html#t:t/0)()

     | [GenLSP.Structures.CallHierarchyRegistrationOptions.t](GenLSP.Structures.CallHierarchyRegistrationOptions.html#t:t/0)())

    | nil,

  code_action_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [GenLSP.Structures.CodeActionOptions.t](GenLSP.Structures.CodeActionOptions.html#t:t/0)()) | nil,

  code_lens_provider: [GenLSP.Structures.CodeLensOptions.t](GenLSP.Structures.CodeLensOptions.html#t:t/0)() | nil,

  color_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.DocumentColorOptions.t](GenLSP.Structures.DocumentColorOptions.html#t:t/0)()

     | [GenLSP.Structures.DocumentColorRegistrationOptions.t](GenLSP.Structures.DocumentColorRegistrationOptions.html#t:t/0)())

    | nil,

  completion_provider: [GenLSP.Structures.CompletionOptions.t](GenLSP.Structures.CompletionOptions.html#t:t/0)() | nil,

  declaration_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.DeclarationOptions.t](GenLSP.Structures.DeclarationOptions.html#t:t/0)()

     | [GenLSP.Structures.DeclarationRegistrationOptions.t](GenLSP.Structures.DeclarationRegistrationOptions.html#t:t/0)())

    | nil,

  definition_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [GenLSP.Structures.DefinitionOptions.t](GenLSP.Structures.DefinitionOptions.html#t:t/0)()) | nil,

  diagnostic_provider:

    ([GenLSP.Structures.DiagnosticOptions.t](GenLSP.Structures.DiagnosticOptions.html#t:t/0)()

     | [GenLSP.Structures.DiagnosticRegistrationOptions.t](GenLSP.Structures.DiagnosticRegistrationOptions.html#t:t/0)())

    | nil,

  document_formatting_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [GenLSP.Structures.DocumentFormattingOptions.t](GenLSP.Structures.DocumentFormattingOptions.html#t:t/0)()) | nil,

  document_highlight_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [GenLSP.Structures.DocumentHighlightOptions.t](GenLSP.Structures.DocumentHighlightOptions.html#t:t/0)()) | nil,

  document_link_provider: [GenLSP.Structures.DocumentLinkOptions.t](GenLSP.Structures.DocumentLinkOptions.html#t:t/0)() | nil,

  document_on_type_formatting_provider:

    [GenLSP.Structures.DocumentOnTypeFormattingOptions.t](GenLSP.Structures.DocumentOnTypeFormattingOptions.html#t:t/0)() | nil,

  document_range_formatting_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [GenLSP.Structures.DocumentRangeFormattingOptions.t](GenLSP.Structures.DocumentRangeFormattingOptions.html#t:t/0)()) | nil,

  document_symbol_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [GenLSP.Structures.DocumentSymbolOptions.t](GenLSP.Structures.DocumentSymbolOptions.html#t:t/0)()) | nil,

  execute_command_provider: [GenLSP.Structures.ExecuteCommandOptions.t](GenLSP.Structures.ExecuteCommandOptions.html#t:t/0)() | nil,

  experimental: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  folding_range_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.FoldingRangeOptions.t](GenLSP.Structures.FoldingRangeOptions.html#t:t/0)()

     | [GenLSP.Structures.FoldingRangeRegistrationOptions.t](GenLSP.Structures.FoldingRangeRegistrationOptions.html#t:t/0)())

    | nil,

  hover_provider: ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [GenLSP.Structures.HoverOptions.t](GenLSP.Structures.HoverOptions.html#t:t/0)()) | nil,

  implementation_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.ImplementationOptions.t](GenLSP.Structures.ImplementationOptions.html#t:t/0)()

     | [GenLSP.Structures.ImplementationRegistrationOptions.t](GenLSP.Structures.ImplementationRegistrationOptions.html#t:t/0)())

    | nil,

  inlay_hint_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.InlayHintOptions.t](GenLSP.Structures.InlayHintOptions.html#t:t/0)()

     | [GenLSP.Structures.InlayHintRegistrationOptions.t](GenLSP.Structures.InlayHintRegistrationOptions.html#t:t/0)())

    | nil,

  inline_value_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.InlineValueOptions.t](GenLSP.Structures.InlineValueOptions.html#t:t/0)()

     | [GenLSP.Structures.InlineValueRegistrationOptions.t](GenLSP.Structures.InlineValueRegistrationOptions.html#t:t/0)())

    | nil,

  linked_editing_range_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.LinkedEditingRangeOptions.t](GenLSP.Structures.LinkedEditingRangeOptions.html#t:t/0)()

     | [GenLSP.Structures.LinkedEditingRangeRegistrationOptions.t](GenLSP.Structures.LinkedEditingRangeRegistrationOptions.html#t:t/0)())

    | nil,

  moniker_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.MonikerOptions.t](GenLSP.Structures.MonikerOptions.html#t:t/0)()

     | [GenLSP.Structures.MonikerRegistrationOptions.t](GenLSP.Structures.MonikerRegistrationOptions.html#t:t/0)())

    | nil,

  notebook_document_sync:

    ([GenLSP.Structures.NotebookDocumentSyncOptions.t](GenLSP.Structures.NotebookDocumentSyncOptions.html#t:t/0)()

     | [GenLSP.Structures.NotebookDocumentSyncRegistrationOptions.t](GenLSP.Structures.NotebookDocumentSyncRegistrationOptions.html#t:t/0)())

    | nil,

  position_encoding: [GenLSP.Enumerations.PositionEncodingKind.t](GenLSP.Enumerations.PositionEncodingKind.html#t:t/0)() | nil,

  references_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [GenLSP.Structures.ReferenceOptions.t](GenLSP.Structures.ReferenceOptions.html#t:t/0)()) | nil,

  rename_provider: ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [GenLSP.Structures.RenameOptions.t](GenLSP.Structures.RenameOptions.html#t:t/0)()) | nil,

  selection_range_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.SelectionRangeOptions.t](GenLSP.Structures.SelectionRangeOptions.html#t:t/0)()

     | [GenLSP.Structures.SelectionRangeRegistrationOptions.t](GenLSP.Structures.SelectionRangeRegistrationOptions.html#t:t/0)())

    | nil,

  semantic_tokens_provider:

    ([GenLSP.Structures.SemanticTokensOptions.t](GenLSP.Structures.SemanticTokensOptions.html#t:t/0)()

     | [GenLSP.Structures.SemanticTokensRegistrationOptions.t](GenLSP.Structures.SemanticTokensRegistrationOptions.html#t:t/0)())

    | nil,

  signature_help_provider: [GenLSP.Structures.SignatureHelpOptions.t](GenLSP.Structures.SignatureHelpOptions.html#t:t/0)() | nil,

  text_document_sync:

    ([GenLSP.Structures.TextDocumentSyncOptions.t](GenLSP.Structures.TextDocumentSyncOptions.html#t:t/0)()

     | [GenLSP.Enumerations.TextDocumentSyncKind.t](GenLSP.Enumerations.TextDocumentSyncKind.html#t:t/0)())

    | nil,

  type_definition_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.TypeDefinitionOptions.t](GenLSP.Structures.TypeDefinitionOptions.html#t:t/0)()

     | [GenLSP.Structures.TypeDefinitionRegistrationOptions.t](GenLSP.Structures.TypeDefinitionRegistrationOptions.html#t:t/0)())

    | nil,

  type_hierarchy_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

     | [GenLSP.Structures.TypeHierarchyOptions.t](GenLSP.Structures.TypeHierarchyOptions.html#t:t/0)()

     | [GenLSP.Structures.TypeHierarchyRegistrationOptions.t](GenLSP.Structures.TypeHierarchyRegistrationOptions.html#t:t/0)())

    | nil,

  workspace: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  workspace_symbol_provider:

    ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [GenLSP.Structures.WorkspaceSymbolOptions.t](GenLSP.Structures.WorkspaceSymbolOptions.html#t:t/0)()) | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ServerCapabilities{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/server_capabilities.ex#L84 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* position\_encoding: The position encoding the server picked from the encodings offered

by the client via the client capability `general.positionEncodings`.

If the client didn't provide any position encodings the only valid

value that a server can return is 'utf-16'.

If omitted it defaults to 'utf-16'.

@since 3.17.0

* text\_document\_sync: Defines how text documents are synced. Is either a detailed structure

defining each notification or for backwards compatibility the

TextDocumentSyncKind number.

* notebook\_document\_sync: Defines how notebook documents are synced.

@since 3.17.0

* completion\_provider: The server provides completion support.

* hover\_provider: The server provides hover support.

* signature\_help\_provider: The server provides signature help support.

* declaration\_provider: The server provides Goto Declaration support.

* definition\_provider: The server provides goto definition support.

* type\_definition\_provider: The server provides Goto Type Definition support.

* implementation\_provider: The server provides Goto Implementation support.

* references\_provider: The server provides find references support.

* document\_highlight\_provider: The server provides document highlight support.

* document\_symbol\_provider: The server provides document symbol support.

* code\_action\_provider: The server provides code actions. CodeActionOptions may only be

specified if the client states that it supports

`codeActionLiteralSupport` in its initial `initialize` request.

* code\_lens\_provider: The server provides code lens.

* document\_link\_provider: The server provides document link support.

* color\_provider: The server provides color provider support.

* workspace\_symbol\_provider: The server provides workspace symbol support.

* document\_formatting\_provider: The server provides document formatting.

* document\_range\_formatting\_provider: The server provides document range formatting.

* document\_on\_type\_formatting\_provider: The server provides document formatting on typing.

* rename\_provider: The server provides rename support. RenameOptions may only be

specified if the client states that it supports

`prepareSupport` in its initial `initialize` request.

* folding\_range\_provider: The server provides folding provider support.

* selection\_range\_provider: The server provides selection range support.

* execute\_command\_provider: The server provides execute command support.

* call\_hierarchy\_provider: The server provides call hierarchy support.

@since 3.16.0

* linked\_editing\_range\_provider: The server provides linked editing range support.

@since 3.16.0

* semantic\_tokens\_provider: The server provides semantic tokens support.

@since 3.16.0

* moniker\_provider: The server provides moniker support.

@since 3.16.0

* type\_hierarchy\_provider: The server provides type hierarchy support.

@since 3.17.0

* inline\_value\_provider: The server provides inline values.

@since 3.17.0

* inlay\_hint\_provider: The server provides inlay hints.

@since 3.17.0

* diagnostic\_provider: The server has support for pull model diagnostics.

@since 3.17.0

* workspace: Workspace specific server capabilities.

* experimental: Experimental server capabilities.





GenLSP.Structures.SetTraceParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/set_trace_params.ex#L2 "View Source")

GenLSP.Structures.SetTraceParams

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SetTraceParams{}](#__struct__/0)

Fields

------

* value

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/set_trace_params.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.SetTraceParams{

  value: [GenLSP.Enumerations.TraceValues.t](GenLSP.Enumerations.TraceValues.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SetTraceParams{}

===================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/set_trace_params.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* value





GenLSP.Structures.ShowDocumentClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_document_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.ShowDocumentClientCapabilities

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================================

Client capabilities for the showDocument request.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ShowDocumentClientCapabilities{}](#__struct__/0)

Fields

------

* support: The client has support for the showDocument

request.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_document_client_capabilities.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.ShowDocumentClientCapabilities{support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ShowDocumentClientCapabilities{}

===================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_document_client_capabilities.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* support: The client has support for the showDocument

request.





GenLSP.Structures.ShowDocumentParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_document_params.ex#L2 "View Source")

GenLSP.Structures.ShowDocumentParams

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================

Params to show a document.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ShowDocumentParams{}](#__struct__/0)

Fields

------

* uri: The document uri to show.

* external: Indicates to show the resource in an external program.

To show for example `https://code.visualstudio.com/`

in the default WEB browser set `external` to `true`.

* take\_focus: An optional property to indicate whether the editor

showing the document should take focus or not.

Clients might ignore this property if an external

program is started.

* selection: An optional selection range if the document is a text

document. Clients might ignore the property if an

external program is started or the file is not a text

file.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_document_params.ex#L30 "View Source")

```

@type t() :: %GenLSP.Structures.ShowDocumentParams{

  external: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  selection: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)() | nil,

  take_focus: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  uri: [GenLSP.BaseTypes.uri](GenLSP.BaseTypes.html#t:uri/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ShowDocumentParams{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_document_params.ex#L30 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: The document uri to show.

* external: Indicates to show the resource in an external program.

To show for example `https://code.visualstudio.com/`

in the default WEB browser set `external` to `true`.

* take\_focus: An optional property to indicate whether the editor

showing the document should take focus or not.

Clients might ignore this property if an external

program is started.

* selection: An optional selection range if the document is a text

document. Clients might ignore the property if an

external program is started or the file is not a text

file.





GenLSP.Structures.ShowDocumentResult — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_document_result.ex#L2 "View Source")

GenLSP.Structures.ShowDocumentResult

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================

The result of a showDocument request.

@since 3.16.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ShowDocumentResult{}](#__struct__/0)

Fields

------

* success: A boolean indicating if the show was successful.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_document_result.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.ShowDocumentResult{success: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ShowDocumentResult{}

=======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_document_result.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* success: A boolean indicating if the show was successful.





GenLSP.Structures.ShowMessageParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_message_params.ex#L2 "View Source")

GenLSP.Structures.ShowMessageParams

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

The parameters of a notification message.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ShowMessageParams{}](#__struct__/0)

Fields

------

* type: The message type. See {@link MessageType}

* message: The actual message.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_message_params.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.ShowMessageParams{

  message: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  type: [GenLSP.Enumerations.MessageType.t](GenLSP.Enumerations.MessageType.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ShowMessageParams{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_message_params.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* type: The message type. See {@link MessageType}

* message: The actual message.





GenLSP.Structures.ShowMessageRequestClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_message_request_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.ShowMessageRequestClientCapabilities

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================================================

Show message request client capabilities

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ShowMessageRequestClientCapabilities{}](#__struct__/0)

Fields

------

* message\_action\_item: Capabilities specific to the `MessageActionItem` type.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_message_request_client_capabilities.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.ShowMessageRequestClientCapabilities{

  message_action_item: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ShowMessageRequestClientCapabilities{}

=========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_message_request_client_capabilities.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* message\_action\_item: Capabilities specific to the `MessageActionItem` type.





GenLSP.Structures.ShowMessageRequestParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_message_request_params.ex#L2 "View Source")

GenLSP.Structures.ShowMessageRequestParams

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.ShowMessageRequestParams{}](#__struct__/0)

Fields

------

* type: The message type. See {@link MessageType}

* message: The actual message.

* actions: The message action items to present.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_message_request_params.ex#L15 "View Source")

```

@type t() :: %GenLSP.Structures.ShowMessageRequestParams{

  actions: [[GenLSP.Structures.MessageActionItem.t](GenLSP.Structures.MessageActionItem.html#t:t/0)()] | nil,

  message: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  type: [GenLSP.Enumerations.MessageType.t](GenLSP.Enumerations.MessageType.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.ShowMessageRequestParams{}

=============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/show_message_request_params.ex#L15 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* type: The message type. See {@link MessageType}

* message: The actual message.

* actions: The message action items to present.





GenLSP.Structures.SignatureHelp — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help.ex#L2 "View Source")

GenLSP.Structures.SignatureHelp

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================

Signature help represents the signature of something

callable. There can be multiple signature but only one

active and only one active parameter.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SignatureHelp{}](#__struct__/0)

Fields

------

* signatures: One or more signatures.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help.ex#L35 "View Source")

```

@type t() :: %GenLSP.Structures.SignatureHelp{

  active_parameter: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)() | nil,

  active_signature: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)() | nil,

  signatures: [[GenLSP.Structures.SignatureInformation.t](GenLSP.Structures.SignatureInformation.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SignatureHelp{}

==================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help.ex#L35 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* signatures: One or more signatures.

* active\_signature: The active signature. If omitted or the value lies outside the

range of `signatures` the value defaults to zero or is ignored if

the `SignatureHelp` has no signatures.

Whenever possible implementors should make an active decision about

the active signature and shouldn't rely on a default value.

In future version of the protocol this property might become

mandatory to better express this.

* active\_parameter: The active parameter of the active signature. If omitted or the value

lies outside the range of `signatures[activeSignature].parameters`

defaults to 0 if the active signature has parameters. If

the active signature has no parameters it is ignored.

In future version of the protocol this property might become

mandatory to better express the active parameter if the

active signature does have any.





GenLSP.Structures.SignatureHelpClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.SignatureHelpClientCapabilities

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

Client Capabilities for a {@link SignatureHelpRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SignatureHelpClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether signature help supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_client_capabilities.ex#L25 "View Source")

```

@type t() :: %GenLSP.Structures.SignatureHelpClientCapabilities{

  context_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  signature_information: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SignatureHelpClientCapabilities{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_client_capabilities.ex#L25 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether signature help supports dynamic registration.

* signature\_information: The client supports the following `SignatureInformation`

specific properties.

* context\_support: The client supports to send additional context information for a

`textDocument/signatureHelp` request. A client that opts into

contextSupport will also support the `retriggerCharacters` on

`SignatureHelpOptions`.

@since 3.15.0





GenLSP.Structures.SignatureHelpContext — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_context.ex#L2 "View Source")

GenLSP.Structures.SignatureHelpContext

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

Additional information about the context in which a signature help request was triggered.

@since 3.15.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SignatureHelpContext{}](#__struct__/0)

Fields

------

* trigger\_kind: Action that caused signature help to be triggered.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_context.ex#L30 "View Source")

```

@type t() :: %GenLSP.Structures.SignatureHelpContext{

  active_signature_help: [GenLSP.Structures.SignatureHelp.t](GenLSP.Structures.SignatureHelp.html#t:t/0)() | nil,

  is_retrigger: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)(),

  trigger_character: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  trigger_kind: [GenLSP.Enumerations.SignatureHelpTriggerKind.t](GenLSP.Enumerations.SignatureHelpTriggerKind.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SignatureHelpContext{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_context.ex#L30 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* trigger\_kind: Action that caused signature help to be triggered.

* trigger\_character: Character that caused signature help to be triggered.

This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`

* is\_retrigger: `true` if signature help was already showing when it was triggered.

Retriggers occurs when the signature help is already active and can be caused by actions such as

typing a trigger character, a cursor move, or document content changes.

* active\_signature\_help: The currently active `SignatureHelp`.

The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on

the user navigating through available signatures.





GenLSP.Structures.SignatureHelpOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_options.ex#L2 "View Source")

GenLSP.Structures.SignatureHelpOptions

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

Server Capabilities for a {@link SignatureHelpRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SignatureHelpOptions{}](#__struct__/0)

Fields

------

* trigger\_characters: List of characters that trigger signature help automatically.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_options.ex#L24 "View Source")

```

@type t() :: %GenLSP.Structures.SignatureHelpOptions{

  retrigger_characters: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil,

  trigger_characters: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil,

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SignatureHelpOptions{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_options.ex#L24 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* trigger\_characters: List of characters that trigger signature help automatically.

* retrigger\_characters: List of characters that re-trigger signature help.

These trigger characters are only active when signature help is already showing. All trigger characters

are also counted as re-trigger characters.

@since 3.15.0

* work\_done\_progress





GenLSP.Structures.SignatureHelpParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_params.ex#L2 "View Source")

GenLSP.Structures.SignatureHelpParams

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================

Parameters for a {@link SignatureHelpRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SignatureHelpParams{}](#__struct__/0)

Fields

------

* context: The signature help context. This is only available if the client specifies

to send this using the client capability `textDocument.signatureHelp.contextSupport === true`

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_params.ex#L23 "View Source")

```

@type t() :: %GenLSP.Structures.SignatureHelpParams{

  context: [GenLSP.Structures.SignatureHelpContext.t](GenLSP.Structures.SignatureHelpContext.html#t:t/0)() | nil,

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SignatureHelpParams{}

========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_params.ex#L23 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* context: The signature help context. This is only available if the client specifies

to send this using the client capability `textDocument.signatureHelp.contextSupport === true`

@since 3.15.0

* work\_done\_token: An optional token that a server can use to report work done progress.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.SignatureHelpRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_registration_options.ex#L2 "View Source")

GenLSP.Structures.SignatureHelpRegistrationOptions

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

Registration options for a {@link SignatureHelpRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SignatureHelpRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_registration_options.ex#L25 "View Source")

```

@type t() :: %GenLSP.Structures.SignatureHelpRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  retrigger_characters: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil,

  trigger_characters: [[String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()] | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SignatureHelpRegistrationOptions{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_help_registration_options.ex#L25 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* trigger\_characters: List of characters that trigger signature help automatically.

* retrigger\_characters: List of characters that re-trigger signature help.

These trigger characters are only active when signature help is already showing. All trigger characters

are also counted as re-trigger characters.

@since 3.15.0





GenLSP.Structures.SignatureInformation — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_information.ex#L2 "View Source")

GenLSP.Structures.SignatureInformation

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================

Represents the signature of something callable. A signature

can have a label, like a function-name, a doc-comment, and

a set of parameters.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SignatureInformation{}](#__struct__/0)

Fields

------

* label: The label of this signature. Will be shown in

the UI.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_information.ex#L28 "View Source")

```

@type t() :: %GenLSP.Structures.SignatureInformation{

  active_parameter: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)() | nil,

  documentation: ([String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | [GenLSP.Structures.MarkupContent.t](GenLSP.Structures.MarkupContent.html#t:t/0)()) | nil,

  label: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  parameters: [[GenLSP.Structures.ParameterInformation.t](GenLSP.Structures.ParameterInformation.html#t:t/0)()] | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SignatureInformation{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/signature_information.ex#L28 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* label: The label of this signature. Will be shown in

the UI.

* documentation: The human-readable doc-comment of this signature. Will be shown

in the UI but can be omitted.

* parameters: The parameters of this signature.

* active\_parameter: The index of the active parameter.

If provided, this is used in place of `SignatureHelp.activeParameter`.

@since 3.16.0





GenLSP.Structures.StaticRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/static_registration_options.ex#L2 "View Source")

GenLSP.Structures.StaticRegistrationOptions

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================

Static registration options to be returned in the initialize

request.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.StaticRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/static_registration_options.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.StaticRegistrationOptions{id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.StaticRegistrationOptions{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/static_registration_options.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.





GenLSP.Structures.SymbolInformation — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/symbol_information.ex#L2 "View Source")

GenLSP.Structures.SymbolInformation

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================

Represents information about programming constructs like variables, classes,

interfaces etc.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.SymbolInformation{}](#__struct__/0)

Fields

------

* deprecated: Indicates if this symbol is deprecated.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/symbol_information.ex#L38 "View Source")

```

@type t() :: %GenLSP.Structures.SymbolInformation{

  container_name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  deprecated: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  kind: [GenLSP.Enumerations.SymbolKind.t](GenLSP.Enumerations.SymbolKind.html#t:t/0)(),

  location: [GenLSP.Structures.Location.t](GenLSP.Structures.Location.html#t:t/0)(),

  name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  tags: [[GenLSP.Enumerations.SymbolTag.t](GenLSP.Enumerations.SymbolTag.html#t:t/0)()] | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.SymbolInformation{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/symbol_information.ex#L38 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* deprecated: Indicates if this symbol is deprecated.

@deprecated Use tags instead

* location: The location of this symbol. The location's range is used by a tool

to reveal the location in the editor. If the symbol is selected in the

tool the range's start information is used to position the cursor. So

the range usually spans more than the actual symbol's name and does

normally include things like visibility modifiers.

The range doesn't have to denote a node range in the sense of an abstract

syntax tree. It can therefore not be used to re-construct a hierarchy of

the symbols.

* name: The name of this symbol.

* kind: The kind of this symbol.

* tags: Tags for this symbol.

@since 3.16.0

* container\_name: The name of the symbol containing this symbol. This information is for

user interface purposes (e.g. to render a qualifier in the user interface

if necessary). It can't be used to re-infer a hierarchy for the document

symbols.





GenLSP.Structures.TextDocumentChangeRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_change_registration_options.ex#L2 "View Source")

GenLSP.Structures.TextDocumentChangeRegistrationOptions

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================================================

Describe options to be used when registered for text document change events.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TextDocumentChangeRegistrationOptions{}](#__struct__/0)

Fields

------

* sync\_kind: How documents are synced to the server.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_change_registration_options.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.TextDocumentChangeRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  sync_kind: [GenLSP.Enumerations.TextDocumentSyncKind.t](GenLSP.Enumerations.TextDocumentSyncKind.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TextDocumentChangeRegistrationOptions{}

==========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_change_registration_options.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* sync\_kind: How documents are synced to the server.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.TextDocumentClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.TextDocumentClientCapabilities

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================================

Text document specific client capabilities.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TextDocumentClientCapabilities{}](#__struct__/0)

Fields

------

* synchronization: Defines which synchronization capabilities the client supports.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_client_capabilities.ex#L75 "View Source")

```

@type t() :: %GenLSP.Structures.TextDocumentClientCapabilities{

  call_hierarchy: [GenLSP.Structures.CallHierarchyClientCapabilities.t](GenLSP.Structures.CallHierarchyClientCapabilities.html#t:t/0)() | nil,

  code_action: [GenLSP.Structures.CodeActionClientCapabilities.t](GenLSP.Structures.CodeActionClientCapabilities.html#t:t/0)() | nil,

  code_lens: [GenLSP.Structures.CodeLensClientCapabilities.t](GenLSP.Structures.CodeLensClientCapabilities.html#t:t/0)() | nil,

  color_provider: [GenLSP.Structures.DocumentColorClientCapabilities.t](GenLSP.Structures.DocumentColorClientCapabilities.html#t:t/0)() | nil,

  completion: [GenLSP.Structures.CompletionClientCapabilities.t](GenLSP.Structures.CompletionClientCapabilities.html#t:t/0)() | nil,

  declaration: [GenLSP.Structures.DeclarationClientCapabilities.t](GenLSP.Structures.DeclarationClientCapabilities.html#t:t/0)() | nil,

  definition: [GenLSP.Structures.DefinitionClientCapabilities.t](GenLSP.Structures.DefinitionClientCapabilities.html#t:t/0)() | nil,

  diagnostic: [GenLSP.Structures.DiagnosticClientCapabilities.t](GenLSP.Structures.DiagnosticClientCapabilities.html#t:t/0)() | nil,

  document_highlight:

    [GenLSP.Structures.DocumentHighlightClientCapabilities.t](GenLSP.Structures.DocumentHighlightClientCapabilities.html#t:t/0)() | nil,

  document_link: [GenLSP.Structures.DocumentLinkClientCapabilities.t](GenLSP.Structures.DocumentLinkClientCapabilities.html#t:t/0)() | nil,

  document_symbol: [GenLSP.Structures.DocumentSymbolClientCapabilities.t](GenLSP.Structures.DocumentSymbolClientCapabilities.html#t:t/0)() | nil,

  folding_range: [GenLSP.Structures.FoldingRangeClientCapabilities.t](GenLSP.Structures.FoldingRangeClientCapabilities.html#t:t/0)() | nil,

  formatting: [GenLSP.Structures.DocumentFormattingClientCapabilities.t](GenLSP.Structures.DocumentFormattingClientCapabilities.html#t:t/0)() | nil,

  hover: [GenLSP.Structures.HoverClientCapabilities.t](GenLSP.Structures.HoverClientCapabilities.html#t:t/0)() | nil,

  implementation: [GenLSP.Structures.ImplementationClientCapabilities.t](GenLSP.Structures.ImplementationClientCapabilities.html#t:t/0)() | nil,

  inlay_hint: [GenLSP.Structures.InlayHintClientCapabilities.t](GenLSP.Structures.InlayHintClientCapabilities.html#t:t/0)() | nil,

  inline_value: [GenLSP.Structures.InlineValueClientCapabilities.t](GenLSP.Structures.InlineValueClientCapabilities.html#t:t/0)() | nil,

  linked_editing_range:

    [GenLSP.Structures.LinkedEditingRangeClientCapabilities.t](GenLSP.Structures.LinkedEditingRangeClientCapabilities.html#t:t/0)() | nil,

  moniker: [GenLSP.Structures.MonikerClientCapabilities.t](GenLSP.Structures.MonikerClientCapabilities.html#t:t/0)() | nil,

  on_type_formatting:

    [GenLSP.Structures.DocumentOnTypeFormattingClientCapabilities.t](GenLSP.Structures.DocumentOnTypeFormattingClientCapabilities.html#t:t/0)() | nil,

  publish_diagnostics:

    [GenLSP.Structures.PublishDiagnosticsClientCapabilities.t](GenLSP.Structures.PublishDiagnosticsClientCapabilities.html#t:t/0)() | nil,

  range_formatting:

    [GenLSP.Structures.DocumentRangeFormattingClientCapabilities.t](GenLSP.Structures.DocumentRangeFormattingClientCapabilities.html#t:t/0)() | nil,

  references: [GenLSP.Structures.ReferenceClientCapabilities.t](GenLSP.Structures.ReferenceClientCapabilities.html#t:t/0)() | nil,

  rename: [GenLSP.Structures.RenameClientCapabilities.t](GenLSP.Structures.RenameClientCapabilities.html#t:t/0)() | nil,

  selection_range: [GenLSP.Structures.SelectionRangeClientCapabilities.t](GenLSP.Structures.SelectionRangeClientCapabilities.html#t:t/0)() | nil,

  semantic_tokens: [GenLSP.Structures.SemanticTokensClientCapabilities.t](GenLSP.Structures.SemanticTokensClientCapabilities.html#t:t/0)() | nil,

  signature_help: [GenLSP.Structures.SignatureHelpClientCapabilities.t](GenLSP.Structures.SignatureHelpClientCapabilities.html#t:t/0)() | nil,

  synchronization:

    [GenLSP.Structures.TextDocumentSyncClientCapabilities.t](GenLSP.Structures.TextDocumentSyncClientCapabilities.html#t:t/0)() | nil,

  type_definition: [GenLSP.Structures.TypeDefinitionClientCapabilities.t](GenLSP.Structures.TypeDefinitionClientCapabilities.html#t:t/0)() | nil,

  type_hierarchy: [GenLSP.Structures.TypeHierarchyClientCapabilities.t](GenLSP.Structures.TypeHierarchyClientCapabilities.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TextDocumentClientCapabilities{}

===================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_client_capabilities.ex#L75 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* synchronization: Defines which synchronization capabilities the client supports.

* completion: Capabilities specific to the `textDocument/completion` request.

* hover: Capabilities specific to the `textDocument/hover` request.

* signature\_help: Capabilities specific to the `textDocument/signatureHelp` request.

* declaration: Capabilities specific to the `textDocument/declaration` request.

@since 3.14.0

* definition: Capabilities specific to the `textDocument/definition` request.

* type\_definition: Capabilities specific to the `textDocument/typeDefinition` request.

@since 3.6.0

* implementation: Capabilities specific to the `textDocument/implementation` request.

@since 3.6.0

* references: Capabilities specific to the `textDocument/references` request.

* document\_highlight: Capabilities specific to the `textDocument/documentHighlight` request.

* document\_symbol: Capabilities specific to the `textDocument/documentSymbol` request.

* code\_action: Capabilities specific to the `textDocument/codeAction` request.

* code\_lens: Capabilities specific to the `textDocument/codeLens` request.

* document\_link: Capabilities specific to the `textDocument/documentLink` request.

* color\_provider: Capabilities specific to the `textDocument/documentColor` and the

`textDocument/colorPresentation` request.

@since 3.6.0

* formatting: Capabilities specific to the `textDocument/formatting` request.

* range\_formatting: Capabilities specific to the `textDocument/rangeFormatting` request.

* on\_type\_formatting: Capabilities specific to the `textDocument/onTypeFormatting` request.

* rename: Capabilities specific to the `textDocument/rename` request.

* folding\_range: Capabilities specific to the `textDocument/foldingRange` request.

@since 3.10.0

* selection\_range: Capabilities specific to the `textDocument/selectionRange` request.

@since 3.15.0

* publish\_diagnostics: Capabilities specific to the `textDocument/publishDiagnostics` notification.

* call\_hierarchy: Capabilities specific to the various call hierarchy requests.

@since 3.16.0

* semantic\_tokens: Capabilities specific to the various semantic token request.

@since 3.16.0

* linked\_editing\_range: Capabilities specific to the `textDocument/linkedEditingRange` request.

@since 3.16.0

* moniker: Client capabilities specific to the `textDocument/moniker` request.

@since 3.16.0

* type\_hierarchy: Capabilities specific to the various type hierarchy requests.

@since 3.17.0

* inline\_value: Capabilities specific to the `textDocument/inlineValue` request.

@since 3.17.0

* inlay\_hint: Capabilities specific to the `textDocument/inlayHint` request.

@since 3.17.0

* diagnostic: Capabilities specific to the diagnostic pull model.

@since 3.17.0





GenLSP.Structures.TextDocumentEdit — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_edit.ex#L2 "View Source")

GenLSP.Structures.TextDocumentEdit

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

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.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TextDocumentEdit{}](#__struct__/0)

Fields

------

* text\_document: The text document to change.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_edit.ex#L24 "View Source")

```

@type t() :: %GenLSP.Structures.TextDocumentEdit{

  edits: [

    [GenLSP.Structures.TextEdit.t](GenLSP.Structures.TextEdit.html#t:t/0)() | [GenLSP.Structures.AnnotatedTextEdit.t](GenLSP.Structures.AnnotatedTextEdit.html#t:t/0)()

  ],

  text_document: [GenLSP.Structures.OptionalVersionedTextDocumentIdentifier.t](GenLSP.Structures.OptionalVersionedTextDocumentIdentifier.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TextDocumentEdit{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_edit.ex#L24 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document to change.

* edits: The edits to be applied.

@since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a

client capability.





GenLSP.Structures.TextDocumentIdentifier — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_identifier.ex#L2 "View Source")

GenLSP.Structures.TextDocumentIdentifier

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================

A literal to identify a text document in the client.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TextDocumentIdentifier{}](#__struct__/0)

Fields

------

* uri: The text document's uri.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_identifier.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.TextDocumentIdentifier{

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TextDocumentIdentifier{}

===========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_identifier.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: The text document's uri.





GenLSP.Structures.TextDocumentItem — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_item.ex#L2 "View Source")

GenLSP.Structures.TextDocumentItem

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

An item to transfer a text document from the client to the

server.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TextDocumentItem{}](#__struct__/0)

Fields

------

* uri: The text document's uri.

* language\_id: The text document's language identifier.

* version: The version number of this document (it will increase after each

change, including undo/redo).

* text: The content of the opened text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_item.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.TextDocumentItem{

  language_id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  text: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)(),

  version: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TextDocumentItem{}

=====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_item.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: The text document's uri.

* language\_id: The text document's language identifier.

* version: The version number of this document (it will increase after each

change, including undo/redo).

* text: The content of the opened text document.





GenLSP.Structures.TextDocumentPositionParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_position_params.ex#L2 "View Source")

GenLSP.Structures.TextDocumentPositionParams

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

A parameter literal used in requests to pass a text document and a position inside that

document.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TextDocumentPositionParams{}](#__struct__/0)

Fields

------

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_position_params.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.TextDocumentPositionParams{

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TextDocumentPositionParams{}

===============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_position_params.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.TextDocumentRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_registration_options.ex#L2 "View Source")

GenLSP.Structures.TextDocumentRegistrationOptions

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

General text document registration options.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TextDocumentRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_registration_options.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.TextDocumentRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TextDocumentRegistrationOptions{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_registration_options.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.TextDocumentSaveRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_save_registration_options.ex#L2 "View Source")

GenLSP.Structures.TextDocumentSaveRegistrationOptions

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================================================

Save registration options.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TextDocumentSaveRegistrationOptions{}](#__struct__/0)

Fields

------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* include\_text: The client is supposed to include the content on save.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_save_registration_options.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.TextDocumentSaveRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  include_text: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TextDocumentSaveRegistrationOptions{}

========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_save_registration_options.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

* include\_text: The client is supposed to include the content on save.





GenLSP.Structures.TextDocumentSyncClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_sync_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.TextDocumentSyncClientCapabilities

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TextDocumentSyncClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether text document synchronization supports dynamic registration.

* will\_save: The client supports sending will save notifications.

* will\_save\_wait\_until: The client supports sending a will save request and

waits for a response providing text edits which will

be applied to the document before it is saved.

* did\_save: The client supports did save notifications.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_sync_client_capabilities.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.TextDocumentSyncClientCapabilities{

  did_save: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  will_save: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  will_save_wait_until: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TextDocumentSyncClientCapabilities{}

=======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_sync_client_capabilities.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether text document synchronization supports dynamic registration.

* will\_save: The client supports sending will save notifications.

* will\_save\_wait\_until: The client supports sending a will save request and

waits for a response providing text edits which will

be applied to the document before it is saved.

* did\_save: The client supports did save notifications.





GenLSP.Structures.TextDocumentSyncOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_sync_options.ex#L2 "View Source")

GenLSP.Structures.TextDocumentSyncOptions

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TextDocumentSyncOptions{}](#__struct__/0)

Fields

------

* open\_close: Open and close notifications are sent to the server. If omitted open close notification should not

be sent.

* change: Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full

and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.

* will\_save: If present will save notifications are sent to the server. If omitted the notification should not be

sent.

* will\_save\_wait\_until: If present will save wait until requests are sent to the server. If omitted the request should not be

sent.

* save: If present save notifications are sent to the server. If omitted the notification should not be

sent.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_sync_options.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.TextDocumentSyncOptions{

  change: [GenLSP.Enumerations.TextDocumentSyncKind.t](GenLSP.Enumerations.TextDocumentSyncKind.html#t:t/0)() | nil,

  open_close: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  save: ([boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | [GenLSP.Structures.SaveOptions.t](GenLSP.Structures.SaveOptions.html#t:t/0)()) | nil,

  will_save: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  will_save_wait_until: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TextDocumentSyncOptions{}

============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_document_sync_options.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* open\_close: Open and close notifications are sent to the server. If omitted open close notification should not

be sent.

* change: Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full

and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.

* will\_save: If present will save notifications are sent to the server. If omitted the notification should not be

sent.

* will\_save\_wait\_until: If present will save wait until requests are sent to the server. If omitted the request should not be

sent.

* save: If present save notifications are sent to the server. If omitted the notification should not be

sent.





GenLSP.Structures.TextEdit — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_edit.ex#L2 "View Source")

GenLSP.Structures.TextEdit

(gen\_lsp v0.6.0)

========================================================================================================================================================================================

A text edit applicable to a text document.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TextEdit{}](#__struct__/0)

Fields

------

* range: The range of the text document to be manipulated. To insert

text into a document create a range where start === end.

* new\_text: The string to be inserted. For delete operations use an

empty string.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_edit.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.TextEdit{

  new_text: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TextEdit{}

=============================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/text_edit.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* range: The range of the text document to be manipulated. To insert

text into a document create a range where start === end.

* new\_text: The string to be inserted. For delete operations use an

empty string.





GenLSP.Structures.TypeDefinitionClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.TypeDefinitionClientCapabilities

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

Since 3.6.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TypeDefinitionClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `TypeDefinitionRegistrationOptions` return value

for the corresponding server capability as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_client_capabilities.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.TypeDefinitionClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  link_support: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TypeDefinitionClientCapabilities{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_client_capabilities.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `TypeDefinitionRegistrationOptions` return value

for the corresponding server capability as well.

* link\_support: The client supports additional metadata in the form of definition links.

Since 3.14.0





GenLSP.Structures.TypeDefinitionOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_options.ex#L2 "View Source")

GenLSP.Structures.TypeDefinitionOptions

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TypeDefinitionOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_options.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.TypeDefinitionOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TypeDefinitionOptions{}

==========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_options.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.TypeDefinitionParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_params.ex#L2 "View Source")

GenLSP.Structures.TypeDefinitionParams

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TypeDefinitionParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_params.ex#L17 "View Source")

```

@type t() :: %GenLSP.Structures.TypeDefinitionParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TypeDefinitionParams{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_params.ex#L17 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.TypeDefinitionRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_registration_options.ex#L2 "View Source")

GenLSP.Structures.TypeDefinitionRegistrationOptions

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TypeDefinitionRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_registration_options.ex#L16 "View Source")

```

@type t() :: %GenLSP.Structures.TypeDefinitionRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TypeDefinitionRegistrationOptions{}

======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_definition_registration_options.ex#L16 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.TypeHierarchyClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.TypeHierarchyClientCapabilities

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TypeHierarchyClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_client_capabilities.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.TypeHierarchyClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TypeHierarchyClientCapabilities{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_client_capabilities.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Whether implementation supports dynamic registration. If this is set to `true`

the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`

return value for the corresponding server capability as well.





GenLSP.Structures.TypeHierarchyItem — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_item.ex#L2 "View Source")

GenLSP.Structures.TypeHierarchyItem

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TypeHierarchyItem{}](#__struct__/0)

Fields

------

* name: The name of this item.

* kind: The kind of this item.

* tags: Tags for this item.

* detail: More detail for this item, e.g. the signature of a function.

* uri: The resource identifier of this item.

* range: The range enclosing this symbol not including leading/trailing whitespace

but everything else, e.g. comments and code.

* selection\_range: The range that should be selected and revealed when this symbol is being

picked, e.g. the name of a function. Must be contained by the

{@link TypeHierarchyItem.range `range`}.

* data: A data entry field that is preserved between a type hierarchy prepare and

supertypes or subtypes requests. It could also be used to identify the

type hierarchy in the server, helping improve the performance on

resolving supertypes and subtypes.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_item.ex#L30 "View Source")

```

@type t() :: %GenLSP.Structures.TypeHierarchyItem{

  data: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  detail: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  kind: [GenLSP.Enumerations.SymbolKind.t](GenLSP.Enumerations.SymbolKind.html#t:t/0)(),

  name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  selection_range: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)(),

  tags: [[GenLSP.Enumerations.SymbolTag.t](GenLSP.Enumerations.SymbolTag.html#t:t/0)()] | nil,

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TypeHierarchyItem{}

======================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_item.ex#L30 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* name: The name of this item.

* kind: The kind of this item.

* tags: Tags for this item.

* detail: More detail for this item, e.g. the signature of a function.

* uri: The resource identifier of this item.

* range: The range enclosing this symbol not including leading/trailing whitespace

but everything else, e.g. comments and code.

* selection\_range: The range that should be selected and revealed when this symbol is being

picked, e.g. the name of a function. Must be contained by the

{@link TypeHierarchyItem.range `range`}.

* data: A data entry field that is preserved between a type hierarchy prepare and

supertypes or subtypes requests. It could also be used to identify the

type hierarchy in the server, helping improve the performance on

resolving supertypes and subtypes.





GenLSP.Structures.TypeHierarchyOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_options.ex#L2 "View Source")

GenLSP.Structures.TypeHierarchyOptions

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================================

Type hierarchy options used during static registration.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TypeHierarchyOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_options.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.TypeHierarchyOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TypeHierarchyOptions{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_options.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.TypeHierarchyPrepareParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_prepare_params.ex#L2 "View Source")

GenLSP.Structures.TypeHierarchyPrepareParams

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

The parameter of a `textDocument/prepareTypeHierarchy` request.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TypeHierarchyPrepareParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

* text\_document: The text document.

* position: The position inside the text document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_prepare_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.TypeHierarchyPrepareParams{

  position: [GenLSP.Structures.Position.t](GenLSP.Structures.Position.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TypeHierarchyPrepareParams{}

===============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_prepare_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.

* text\_document: The text document.

* position: The position inside the text document.





GenLSP.Structures.TypeHierarchyRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_registration_options.ex#L2 "View Source")

GenLSP.Structures.TypeHierarchyRegistrationOptions

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

Type hierarchy options used during static or dynamic registration.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TypeHierarchyRegistrationOptions{}](#__struct__/0)

Fields

------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_registration_options.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.TypeHierarchyRegistrationOptions{

  document_selector: [GenLSP.TypeAlias.DocumentSelector.t](GenLSP.TypeAlias.DocumentSelector.html#t:t/0)() | nil,

  id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TypeHierarchyRegistrationOptions{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_registration_options.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to register the request. The id can be used to deregister

the request again. See also Registration#id.

* document\_selector: A document selector to identify the scope of the registration. If set to null

the document selector provided on the client side will be used.





GenLSP.Structures.TypeHierarchySubtypesParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_subtypes_params.ex#L2 "View Source")

GenLSP.Structures.TypeHierarchySubtypesParams

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================

The parameter of a `typeHierarchy/subtypes` request.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TypeHierarchySubtypesParams{}](#__struct__/0)

Fields

------

* item

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_subtypes_params.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.TypeHierarchySubtypesParams{

  item: [GenLSP.Structures.TypeHierarchyItem.t](GenLSP.Structures.TypeHierarchyItem.html#t:t/0)(),

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TypeHierarchySubtypesParams{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_subtypes_params.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* item

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.TypeHierarchySupertypesParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_supertypes_params.ex#L2 "View Source")

GenLSP.Structures.TypeHierarchySupertypesParams

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================================================

The parameter of a `typeHierarchy/supertypes` request.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.TypeHierarchySupertypesParams{}](#__struct__/0)

Fields

------

* item

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_supertypes_params.ex#L22 "View Source")

```

@type t() :: %GenLSP.Structures.TypeHierarchySupertypesParams{

  item: [GenLSP.Structures.TypeHierarchyItem.t](GenLSP.Structures.TypeHierarchyItem.html#t:t/0)(),

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.TypeHierarchySupertypesParams{}

==================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/type_hierarchy_supertypes_params.ex#L22 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* item

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.UnchangedDocumentDiagnosticReport — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/unchanged_document_diagnostic_report.ex#L2 "View Source")

GenLSP.Structures.UnchangedDocumentDiagnosticReport

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================================

A diagnostic report indicating that the last returned

report is still accurate.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.UnchangedDocumentDiagnosticReport{}](#__struct__/0)

Fields

------

* kind: A document diagnostic report indicating

no changes to the last result. A server can

only return `unchanged` if result ids are

provided.

* result\_id: A result id which will be sent on the next

diagnostic request for the same document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/unchanged_document_diagnostic_report.ex#L25 "View Source")

```

@type t() :: %GenLSP.Structures.UnchangedDocumentDiagnosticReport{

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  result_id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.UnchangedDocumentDiagnosticReport{}

======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/unchanged_document_diagnostic_report.ex#L25 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* kind: A document diagnostic report indicating

no changes to the last result. A server can

only return `unchanged` if result ids are

provided.

* result\_id: A result id which will be sent on the next

diagnostic request for the same document.





GenLSP.Structures.Unregistration — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/unregistration.ex#L2 "View Source")

GenLSP.Structures.Unregistration

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================

General parameters to unregister a request or notification.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.Unregistration{}](#__struct__/0)

Fields

------

* id: The id used to unregister the request or notification. Usually an id

provided during the register request.

* method: The method to unregister for.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/unregistration.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.Unregistration{id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(), method: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.Unregistration{}

===================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/unregistration.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* id: The id used to unregister the request or notification. Usually an id

provided during the register request.

* method: The method to unregister for.





GenLSP.Structures.UnregistrationParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/unregistration_params.ex#L2 "View Source")

GenLSP.Structures.UnregistrationParams

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.UnregistrationParams{}](#__struct__/0)

Fields

------

* unregisterations

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/unregistration_params.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.UnregistrationParams{

  unregisterations: [[GenLSP.Structures.Unregistration.t](GenLSP.Structures.Unregistration.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.UnregistrationParams{}

=========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/unregistration_params.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* unregisterations





GenLSP.Structures.VersionedNotebookDocumentIdentifier — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/versioned_notebook_document_identifier.ex#L2 "View Source")

GenLSP.Structures.VersionedNotebookDocumentIdentifier

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================================

A versioned notebook document identifier.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.VersionedNotebookDocumentIdentifier{}](#__struct__/0)

Fields

------

* version: The version number of this notebook document.

* uri: The notebook document's uri.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/versioned_notebook_document_identifier.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.VersionedNotebookDocumentIdentifier{

  uri: [GenLSP.BaseTypes.uri](GenLSP.BaseTypes.html#t:uri/0)(),

  version: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.VersionedNotebookDocumentIdentifier{}

========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/versioned_notebook_document_identifier.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* version: The version number of this notebook document.

* uri: The notebook document's uri.





GenLSP.Structures.VersionedTextDocumentIdentifier — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/versioned_text_document_identifier.ex#L2 "View Source")

GenLSP.Structures.VersionedTextDocumentIdentifier

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

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

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.VersionedTextDocumentIdentifier{}](#__struct__/0)

Fields

------

* version: The version number of this document.

* uri: The text document's uri.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/versioned_text_document_identifier.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.VersionedTextDocumentIdentifier{

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)(),

  version: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.VersionedTextDocumentIdentifier{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/versioned_text_document_identifier.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* version: The version number of this document.

* uri: The text document's uri.





GenLSP.Structures.WillSaveTextDocumentParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/will_save_text_document_params.ex#L2 "View Source")

GenLSP.Structures.WillSaveTextDocumentParams

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================================

The parameters sent in a will save text document notification.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WillSaveTextDocumentParams{}](#__struct__/0)

Fields

------

* text\_document: The document that will be saved.

* reason: The 'TextDocumentSaveReason'.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/will_save_text_document_params.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.WillSaveTextDocumentParams{

  reason: [GenLSP.Enumerations.TextDocumentSaveReason.t](GenLSP.Enumerations.TextDocumentSaveReason.html#t:t/0)(),

  text_document: [GenLSP.Structures.TextDocumentIdentifier.t](GenLSP.Structures.TextDocumentIdentifier.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WillSaveTextDocumentParams{}

===============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/will_save_text_document_params.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* text\_document: The document that will be saved.

* reason: The 'TextDocumentSaveReason'.





GenLSP.Structures.WindowClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/window_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.WindowClientCapabilities

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WindowClientCapabilities{}](#__struct__/0)

Fields

------

* work\_done\_progress: It indicates whether the client supports server initiated

progress using the `window/workDoneProgress/create` request.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/window_client_capabilities.ex#L27 "View Source")

```

@type t() :: %GenLSP.Structures.WindowClientCapabilities{

  show_document: [GenLSP.Structures.ShowDocumentClientCapabilities.t](GenLSP.Structures.ShowDocumentClientCapabilities.html#t:t/0)() | nil,

  show_message:

    [GenLSP.Structures.ShowMessageRequestClientCapabilities.t](GenLSP.Structures.ShowMessageRequestClientCapabilities.html#t:t/0)() | nil,

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WindowClientCapabilities{}

=============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/window_client_capabilities.ex#L27 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress: It indicates whether the client supports server initiated

progress using the `window/workDoneProgress/create` request.

The capability also controls Whether client supports handling

of progress notifications. If set servers are allowed to report a

`workDoneProgress` property in the request specific server

capabilities.

@since 3.15.0

* show\_message: Capabilities specific to the showMessage request.

@since 3.16.0

* show\_document: Capabilities specific to the showDocument request.

@since 3.16.0





GenLSP.Structures.WorkDoneProgressBegin — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_begin.ex#L2 "View Source")

GenLSP.Structures.WorkDoneProgressBegin

(gen\_lsp v0.6.0)

====================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkDoneProgressBegin{}](#__struct__/0)

Fields

------

* kind

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_begin.ex#L31 "View Source")

```

@type t() :: %GenLSP.Structures.WorkDoneProgressBegin{

  cancellable: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  message: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  percentage: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)() | nil,

  title: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkDoneProgressBegin{}

==========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_begin.ex#L31 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* kind

* title: Mandatory title of the progress operation. Used to briefly inform about

the kind of operation being performed.

Examples: "Indexing" or "Linking dependencies".

* cancellable: Controls if a cancel button should show to allow the user to cancel the

long running operation. Clients that don't support cancellation are allowed

to ignore the setting.

* message: Optional, more detailed associated progress message. Contains

complementary information to the `title`.

Examples: "3/25 files", "project/src/module2", "node\_modules/some\_dep".

If unset, the previous progress message (if any) is still valid.

* percentage: Optional progress percentage to display (value 100 is considered 100%).

If not provided infinite progress is assumed and clients are allowed

to ignore the `percentage` value in subsequent in report notifications.

The value should be steadily rising. Clients are free to ignore values

that are not following this rule. The value range is [0, 100].





GenLSP.Structures.WorkDoneProgressCancelParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_cancel_params.ex#L2 "View Source")

GenLSP.Structures.WorkDoneProgressCancelParams

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkDoneProgressCancelParams{}](#__struct__/0)

Fields

------

* token: The token to be used to report progress.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_cancel_params.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.WorkDoneProgressCancelParams{

  token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkDoneProgressCancelParams{}

=================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_cancel_params.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* token: The token to be used to report progress.





GenLSP.Structures.WorkDoneProgressCreateParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_create_params.ex#L2 "View Source")

GenLSP.Structures.WorkDoneProgressCreateParams

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkDoneProgressCreateParams{}](#__struct__/0)

Fields

------

* token: The token to be used to report progress.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_create_params.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.WorkDoneProgressCreateParams{

  token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkDoneProgressCreateParams{}

=================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_create_params.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* token: The token to be used to report progress.





GenLSP.Structures.WorkDoneProgressEnd — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_end.ex#L2 "View Source")

GenLSP.Structures.WorkDoneProgressEnd

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkDoneProgressEnd{}](#__struct__/0)

Fields

------

* kind

* message: Optional, a final message indicating to for example indicate the outcome

of the operation.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_end.ex#L15 "View Source")

```

@type t() :: %GenLSP.Structures.WorkDoneProgressEnd{

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  message: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkDoneProgressEnd{}

========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_end.ex#L15 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* kind

* message: Optional, a final message indicating to for example indicate the outcome

of the operation.





GenLSP.Structures.WorkDoneProgressOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_options.ex#L2 "View Source")

GenLSP.Structures.WorkDoneProgressOptions

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkDoneProgressOptions{}](#__struct__/0)

Fields

------

* work\_done\_progress

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_options.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.WorkDoneProgressOptions{

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkDoneProgressOptions{}

============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_options.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_progress





GenLSP.Structures.WorkDoneProgressParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_params.ex#L2 "View Source")

GenLSP.Structures.WorkDoneProgressParams

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkDoneProgressParams{}](#__struct__/0)

Fields

------

* work\_done\_token: An optional token that a server can use to report work done progress.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_params.ex#L13 "View Source")

```

@type t() :: %GenLSP.Structures.WorkDoneProgressParams{

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkDoneProgressParams{}

===========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_params.ex#L13 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* work\_done\_token: An optional token that a server can use to report work done progress.





GenLSP.Structures.WorkDoneProgressReport — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_report.ex#L2 "View Source")

GenLSP.Structures.WorkDoneProgressReport

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkDoneProgressReport{}](#__struct__/0)

Fields

------

* kind

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_report.ex#L28 "View Source")

```

@type t() :: %GenLSP.Structures.WorkDoneProgressReport{

  cancellable: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  message: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  percentage: [GenLSP.BaseTypes.uinteger](GenLSP.BaseTypes.html#t:uinteger/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkDoneProgressReport{}

===========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/work_done_progress_report.ex#L28 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* kind

* cancellable: Controls enablement state of a cancel button.

Clients that don't support cancellation or don't support controlling the button's

enablement state are allowed to ignore the property.

* message: Optional, more detailed associated progress message. Contains

complementary information to the `title`.

Examples: "3/25 files", "project/src/module2", "node\_modules/some\_dep".

If unset, the previous progress message (if any) is still valid.

* percentage: Optional progress percentage to display (value 100 is considered 100%).

If not provided infinite progress is assumed and clients are allowed

to ignore the `percentage` value in subsequent in report notifications.

The value should be steadily rising. Clients are free to ignore values

that are not following this rule. The value range is [0, 100]





GenLSP.Structures.WorkspaceClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.WorkspaceClientCapabilities

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================================

Workspace specific client capabilities.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceClientCapabilities{}](#__struct__/0)

Fields

------

* apply\_edit: The client supports applying batch edits

to the workspace by supporting the request

'workspace/applyEdit'

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_client_capabilities.ex#L53 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceClientCapabilities{

  apply_edit: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  code_lens: [GenLSP.Structures.CodeLensWorkspaceClientCapabilities.t](GenLSP.Structures.CodeLensWorkspaceClientCapabilities.html#t:t/0)() | nil,

  configuration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  diagnostics:

    [GenLSP.Structures.DiagnosticWorkspaceClientCapabilities.t](GenLSP.Structures.DiagnosticWorkspaceClientCapabilities.html#t:t/0)() | nil,

  did_change_configuration:

    [GenLSP.Structures.DidChangeConfigurationClientCapabilities.t](GenLSP.Structures.DidChangeConfigurationClientCapabilities.html#t:t/0)() | nil,

  did_change_watched_files:

    [GenLSP.Structures.DidChangeWatchedFilesClientCapabilities.t](GenLSP.Structures.DidChangeWatchedFilesClientCapabilities.html#t:t/0)() | nil,

  execute_command: [GenLSP.Structures.ExecuteCommandClientCapabilities.t](GenLSP.Structures.ExecuteCommandClientCapabilities.html#t:t/0)() | nil,

  file_operations: [GenLSP.Structures.FileOperationClientCapabilities.t](GenLSP.Structures.FileOperationClientCapabilities.html#t:t/0)() | nil,

  inlay_hint: [GenLSP.Structures.InlayHintWorkspaceClientCapabilities.t](GenLSP.Structures.InlayHintWorkspaceClientCapabilities.html#t:t/0)() | nil,

  inline_value:

    [GenLSP.Structures.InlineValueWorkspaceClientCapabilities.t](GenLSP.Structures.InlineValueWorkspaceClientCapabilities.html#t:t/0)() | nil,

  semantic_tokens:

    [GenLSP.Structures.SemanticTokensWorkspaceClientCapabilities.t](GenLSP.Structures.SemanticTokensWorkspaceClientCapabilities.html#t:t/0)() | nil,

  symbol: [GenLSP.Structures.WorkspaceSymbolClientCapabilities.t](GenLSP.Structures.WorkspaceSymbolClientCapabilities.html#t:t/0)() | nil,

  workspace_edit: [GenLSP.Structures.WorkspaceEditClientCapabilities.t](GenLSP.Structures.WorkspaceEditClientCapabilities.html#t:t/0)() | nil,

  workspace_folders: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceClientCapabilities{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_client_capabilities.ex#L53 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* apply\_edit: The client supports applying batch edits

to the workspace by supporting the request

'workspace/applyEdit'

* workspace\_edit: Capabilities specific to `WorkspaceEdit`s.

* did\_change\_configuration: Capabilities specific to the `workspace/didChangeConfiguration` notification.

* did\_change\_watched\_files: Capabilities specific to the `workspace/didChangeWatchedFiles` notification.

* symbol: Capabilities specific to the `workspace/symbol` request.

* execute\_command: Capabilities specific to the `workspace/executeCommand` request.

* workspace\_folders: The client has support for workspace folders.

@since 3.6.0

* configuration: The client supports `workspace/configuration` requests.

@since 3.6.0

* semantic\_tokens: Capabilities specific to the semantic token requests scoped to the

workspace.

@since 3.16.0.

* code\_lens: Capabilities specific to the code lens requests scoped to the

workspace.

@since 3.16.0.

* file\_operations: The client has support for file notifications/requests for user operations on files.

Since 3.16.0

* inline\_value: Capabilities specific to the inline values requests scoped to the

workspace.

@since 3.17.0.

* inlay\_hint: Capabilities specific to the inlay hint requests scoped to the

workspace.

@since 3.17.0.

* diagnostics: Capabilities specific to the diagnostic requests scoped to the

workspace.

@since 3.17.0.





GenLSP.Structures.WorkspaceDiagnosticParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_diagnostic_params.ex#L2 "View Source")

GenLSP.Structures.WorkspaceDiagnosticParams

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================

Parameters of the workspace diagnostic request.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceDiagnosticParams{}](#__struct__/0)

Fields

------

* identifier: The additional identifier provided during registration.

* previous\_result\_ids: The currently known diagnostic reports with their

previous result ids.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_diagnostic_params.ex#L24 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceDiagnosticParams{

  identifier: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  previous_result_ids: [[GenLSP.Structures.PreviousResultId.t](GenLSP.Structures.PreviousResultId.html#t:t/0)()],

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceDiagnosticParams{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_diagnostic_params.ex#L24 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* identifier: The additional identifier provided during registration.

* previous\_result\_ids: The currently known diagnostic reports with their

previous result ids.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.WorkspaceDiagnosticReport — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_diagnostic_report.ex#L2 "View Source")

GenLSP.Structures.WorkspaceDiagnosticReport

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================================================

A workspace diagnostic report.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceDiagnosticReport{}](#__struct__/0)

Fields

------

* items

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_diagnostic_report.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceDiagnosticReport{

  items: [[GenLSP.TypeAlias.WorkspaceDocumentDiagnosticReport.t](GenLSP.TypeAlias.WorkspaceDocumentDiagnosticReport.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceDiagnosticReport{}

==============================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_diagnostic_report.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* items





GenLSP.Structures.WorkspaceDiagnosticReportPartialResult — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_diagnostic_report_partial_result.ex#L2 "View Source")

GenLSP.Structures.WorkspaceDiagnosticReportPartialResult

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================================================================

A partial result for a workspace diagnostic report.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceDiagnosticReportPartialResult{}](#__struct__/0)

Fields

------

* items

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_diagnostic_report_partial_result.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceDiagnosticReportPartialResult{

  items: [[GenLSP.TypeAlias.WorkspaceDocumentDiagnosticReport.t](GenLSP.TypeAlias.WorkspaceDocumentDiagnosticReport.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceDiagnosticReportPartialResult{}

===========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_diagnostic_report_partial_result.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* items





GenLSP.Structures.WorkspaceEdit — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_edit.ex#L2 "View Source")

GenLSP.Structures.WorkspaceEdit

(gen\_lsp v0.6.0)

==================================================================================================================================================================================================

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.

Since version 3.13.0 a workspace edit can contain resource operations as well. If resource

operations are present clients need to execute the operations in the order in which they

are provided. So a workspace edit for example can consist of the following two changes:

(1) a create file a.txt and (2) a text document edit which insert text into file a.txt.

An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will

cause failure of the operation. How the client recovers from the failure is described by

the client capability: `workspace.workspaceEdit.failureHandling`

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceEdit{}](#__struct__/0)

Fields

------

* changes: Holds changes to existing resources.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_edit.ex#L44 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceEdit{

  change_annotations:

    %{

      required([GenLSP.TypeAlias.ChangeAnnotationIdentifier.t](GenLSP.TypeAlias.ChangeAnnotationIdentifier.html#t:t/0)()) =>

        [GenLSP.Structures.ChangeAnnotation.t](GenLSP.Structures.ChangeAnnotation.html#t:t/0)()

    }

    | nil,

  changes:

    %{

      required([GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)()) => [

        [GenLSP.Structures.TextEdit.t](GenLSP.Structures.TextEdit.html#t:t/0)()

      ]

    }

    | nil,

  document_changes:

    [

      [GenLSP.Structures.TextDocumentEdit.t](GenLSP.Structures.TextDocumentEdit.html#t:t/0)()

      | [GenLSP.Structures.CreateFile.t](GenLSP.Structures.CreateFile.html#t:t/0)()

      | [GenLSP.Structures.RenameFile.t](GenLSP.Structures.RenameFile.html#t:t/0)()

      | [GenLSP.Structures.DeleteFile.t](GenLSP.Structures.DeleteFile.html#t:t/0)()

    ]

    | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceEdit{}

==================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_edit.ex#L44 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* changes: Holds changes to existing resources.

* document\_changes: Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes

are either an array of `TextDocumentEdit`s to express changes to n different text documents

where each text document edit addresses a specific version of a text document. Or it can contain

above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations.

Whether a client supports versioned document edits is expressed via

`workspace.workspaceEdit.documentChanges` client capability.

If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then

only plain `TextEdit`s using the `changes` property are supported.

* change\_annotations: A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and

delete file / folder operations.

Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`.

@since 3.16.0





GenLSP.Structures.WorkspaceEditClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_edit_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.WorkspaceEditClientCapabilities

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceEditClientCapabilities{}](#__struct__/0)

Fields

------

* document\_changes: The client supports versioned document changes in `WorkspaceEdit`s

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_edit_client_capabilities.ex#L32 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceEditClientCapabilities{

  change_annotation_support: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  document_changes: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  failure_handling: [GenLSP.Enumerations.FailureHandlingKind.t](GenLSP.Enumerations.FailureHandlingKind.html#t:t/0)() | nil,

  normalizes_line_endings: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  resource_operations: [[GenLSP.Enumerations.ResourceOperationKind.t](GenLSP.Enumerations.ResourceOperationKind.html#t:t/0)()] | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceEditClientCapabilities{}

====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_edit_client_capabilities.ex#L32 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* document\_changes: The client supports versioned document changes in `WorkspaceEdit`s

* resource\_operations: The resource operations the client supports. Clients should at least

support 'create', 'rename' and 'delete' files and folders.

@since 3.13.0

* failure\_handling: The failure handling strategy of a client if applying the workspace edit

fails.

@since 3.13.0

* normalizes\_line\_endings: Whether the client normalizes line endings to the client specific

setting.

If set to `true` the client will normalize line ending characters

in a workspace edit to the client-specified new line

character.

@since 3.16.0

* change\_annotation\_support: Whether the client in general supports change annotations on text edits,

create file, rename file and delete file changes.

@since 3.16.0





GenLSP.Structures.WorkspaceFolder — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folder.ex#L2 "View Source")

GenLSP.Structures.WorkspaceFolder

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================

A workspace folder inside a client.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceFolder{}](#__struct__/0)

Fields

------

* uri: The associated URI for this workspace folder.

* name: The name of the workspace folder. Used to refer to this

workspace folder in the user interface.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folder.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceFolder{

  name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  uri: [GenLSP.BaseTypes.uri](GenLSP.BaseTypes.html#t:uri/0)()

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceFolder{}

====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folder.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: The associated URI for this workspace folder.

* name: The name of the workspace folder. Used to refer to this

workspace folder in the user interface.





GenLSP.Structures.WorkspaceFoldersChangeEvent — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folders_change_event.ex#L2 "View Source")

GenLSP.Structures.WorkspaceFoldersChangeEvent

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================================

The workspace folder change event.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceFoldersChangeEvent{}](#__struct__/0)

Fields

------

* added: The array of added workspace folders

* removed: The array of the removed workspace folders

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folders_change_event.ex#L18 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceFoldersChangeEvent{

  added: [[GenLSP.Structures.WorkspaceFolder.t](GenLSP.Structures.WorkspaceFolder.html#t:t/0)()],

  removed: [[GenLSP.Structures.WorkspaceFolder.t](GenLSP.Structures.WorkspaceFolder.html#t:t/0)()]

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceFoldersChangeEvent{}

================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folders_change_event.ex#L18 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* added: The array of added workspace folders

* removed: The array of the removed workspace folders





GenLSP.Structures.WorkspaceFoldersInitializeParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folders_initialize_params.ex#L2 "View Source")

GenLSP.Structures.WorkspaceFoldersInitializeParams

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceFoldersInitializeParams{}](#__struct__/0)

Fields

------

* workspace\_folders: The workspace folders configured in the client when the server starts.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folders_initialize_params.ex#L19 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceFoldersInitializeParams{

  workspace_folders: ([[GenLSP.Structures.WorkspaceFolder.t](GenLSP.Structures.WorkspaceFolder.html#t:t/0)()] | nil) | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceFoldersInitializeParams{}

=====================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folders_initialize_params.ex#L19 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* workspace\_folders: The workspace folders configured in the client when the server starts.

This property is only available if the client supports workspace folders.

It can be `null` if the client supports workspace folders but none are

configured.

@since 3.6.0





GenLSP.Structures.WorkspaceFoldersServerCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folders_server_capabilities.ex#L2 "View Source")

GenLSP.Structures.WorkspaceFoldersServerCapabilities

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceFoldersServerCapabilities{}](#__struct__/0)

Fields

------

* supported: The server has support for workspace folders

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folders_server_capabilities.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceFoldersServerCapabilities{

  change_notifications: ([String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()) | nil,

  supported: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceFoldersServerCapabilities{}

=======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_folders_server_capabilities.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* supported: The server has support for workspace folders

* change\_notifications: Whether the server wants to receive workspace folder

change notifications.

If a string is provided the string is treated as an ID

under which the notification is registered on the client

side. The ID can be used to unregister for these events

using the `client/unregisterCapability` request.





GenLSP.Structures.WorkspaceFullDocumentDiagnosticReport — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_full_document_diagnostic_report.ex#L2 "View Source")

GenLSP.Structures.WorkspaceFullDocumentDiagnosticReport

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================================================

A full document diagnostic report for a workspace diagnostic result.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceFullDocumentDiagnosticReport{}](#__struct__/0)

Fields

------

* uri: The URI for which diagnostic information is reported.

* version: The version number for which the diagnostics are reported.

If the document is not marked as open `null` can be provided.

* kind: A full document diagnostic report.

* result\_id: An optional result id. If provided it will

be sent on the next diagnostic request for the

same document.

* items: The actual items.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_full_document_diagnostic_report.ex#L26 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceFullDocumentDiagnosticReport{

  items: [[GenLSP.Structures.Diagnostic.t](GenLSP.Structures.Diagnostic.html#t:t/0)()],

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  result_id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)(),

  version: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceFullDocumentDiagnosticReport{}

==========================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_full_document_diagnostic_report.ex#L26 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: The URI for which diagnostic information is reported.

* version: The version number for which the diagnostics are reported.

If the document is not marked as open `null` can be provided.

* kind: A full document diagnostic report.

* result\_id: An optional result id. If provided it will

be sent on the next diagnostic request for the

same document.

* items: The actual items.





GenLSP.Structures.WorkspaceSymbol — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol.ex#L2 "View Source")

GenLSP.Structures.WorkspaceSymbol

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================

A special workspace symbol that supports locations without a range.

See also SymbolInformation.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceSymbol{}](#__struct__/0)

Fields

------

* location: The location of the symbol. Whether a server is allowed to

return a location without a range depends on the client

capability `workspace.symbol.resolveSupport`.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol.ex#L36 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceSymbol{

  container_name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | nil,

  data: [GenLSP.TypeAlias.LSPAny.t](GenLSP.TypeAlias.LSPAny.html#t:t/0)() | nil,

  kind: [GenLSP.Enumerations.SymbolKind.t](GenLSP.Enumerations.SymbolKind.html#t:t/0)(),

  location: [GenLSP.Structures.Location.t](GenLSP.Structures.Location.html#t:t/0)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)(),

  name: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  tags: [[GenLSP.Enumerations.SymbolTag.t](GenLSP.Enumerations.SymbolTag.html#t:t/0)()] | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceSymbol{}

====================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol.ex#L36 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* location: The location of the symbol. Whether a server is allowed to

return a location without a range depends on the client

capability `workspace.symbol.resolveSupport`.

See SymbolInformation#location for more details.

* data: A data entry field that is preserved on a workspace symbol between a

workspace symbol request and a workspace symbol resolve request.

* name: The name of this symbol.

* kind: The kind of this symbol.

* tags: Tags for this symbol.

@since 3.16.0

* container\_name: The name of the symbol containing this symbol. This information is for

user interface purposes (e.g. to render a qualifier in the user interface

if necessary). It can't be used to re-infer a hierarchy for the document

symbols.





GenLSP.Structures.WorkspaceSymbolClientCapabilities — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_client_capabilities.ex#L2 "View Source")

GenLSP.Structures.WorkspaceSymbolClientCapabilities

(gen\_lsp v0.6.0)

============================================================================================================================================================================================================================================

Client capabilities for a {@link WorkspaceSymbolRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceSymbolClientCapabilities{}](#__struct__/0)

Fields

------

* dynamic\_registration: Symbol request supports dynamic registration.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_client_capabilities.ex#L27 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceSymbolClientCapabilities{

  dynamic_registration: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  resolve_support: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  symbol_kind: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil,

  tag_support: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceSymbolClientCapabilities{}

======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_client_capabilities.ex#L27 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* dynamic\_registration: Symbol request supports dynamic registration.

* symbol\_kind: Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.

* tag\_support: The client supports tags on `SymbolInformation`.

Clients supporting tags have to handle unknown tags gracefully.

@since 3.16.0

* resolve\_support: The client support partial workspace symbols. The client will send the

request `workspaceSymbol/resolve` to the server to resolve additional

properties.

@since 3.17.0





GenLSP.Structures.WorkspaceSymbolOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_options.ex#L2 "View Source")

GenLSP.Structures.WorkspaceSymbolOptions

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================================

Server capabilities for a {@link WorkspaceSymbolRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceSymbolOptions{}](#__struct__/0)

Fields

------

* resolve\_provider: The server provides support to resolve additional

information for a workspace symbol.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_options.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceSymbolOptions{

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil,

  work_done_progress: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceSymbolOptions{}

===========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_options.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* resolve\_provider: The server provides support to resolve additional

information for a workspace symbol.

@since 3.17.0

* work\_done\_progress





GenLSP.Structures.WorkspaceSymbolParams — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_params.ex#L2 "View Source")

GenLSP.Structures.WorkspaceSymbolParams

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================================

The parameters of a {@link WorkspaceSymbolRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceSymbolParams{}](#__struct__/0)

Fields

------

* query: A query string to filter symbols by. Clients may send an empty

string here to request all symbols.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_params.ex#L21 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceSymbolParams{

  partial_result_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil,

  query: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  work_done_token: [GenLSP.TypeAlias.ProgressToken.t](GenLSP.TypeAlias.ProgressToken.html#t:t/0)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceSymbolParams{}

==========================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_params.ex#L21 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* query: A query string to filter symbols by. Clients may send an empty

string here to request all symbols.

* work\_done\_token: An optional token that a server can use to report work done progress.

* partial\_result\_token: An optional token that a server can use to report partial results (e.g. streaming) to

the client.





GenLSP.Structures.WorkspaceSymbolRegistrationOptions — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_registration_options.ex#L2 "View Source")

GenLSP.Structures.WorkspaceSymbolRegistrationOptions

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================================

Registration options for a {@link WorkspaceSymbolRequest}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceSymbolRegistrationOptions{}](#__struct__/0)

Fields

------

* resolve\_provider: The server provides support to resolve additional

information for a workspace symbol.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_registration_options.ex#L20 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceSymbolRegistrationOptions{

  resolve_provider: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceSymbolRegistrationOptions{}

=======================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_symbol_registration_options.ex#L20 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* resolve\_provider: The server provides support to resolve additional

information for a workspace symbol.

@since 3.17.0





GenLSP.Structures.WorkspaceUnchangedDocumentDiagnosticReport — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_unchanged_document_diagnostic_report.ex#L2 "View Source")

GenLSP.Structures.WorkspaceUnchangedDocumentDiagnosticReport

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================================================================================

An unchanged document diagnostic report for a workspace diagnostic result.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Functions](#functions)

------------------------

[%GenLSP.Structures.WorkspaceUnchangedDocumentDiagnosticReport{}](#__struct__/0)

Fields

------

* uri: The URI for which diagnostic information is reported.

* version: The version number for which the diagnostics are reported.

If the document is not marked as open `null` can be provided.

* kind: A document diagnostic report indicating

no changes to the last result. A server can

only return `unchanged` if result ids are

provided.

* result\_id: A result id which will be sent on the next

diagnostic request for the same document.

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_unchanged_document_diagnostic_report.ex#L27 "View Source")

```

@type t() :: %GenLSP.Structures.WorkspaceUnchangedDocumentDiagnosticReport{

  kind: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  result_id: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)(),

  uri: [GenLSP.BaseTypes.document\_uri](GenLSP.BaseTypes.html#t:document_uri/0)(),

  version: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | nil

}

```

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#__struct__/0 "Link to this function")

%GenLSP.Structures.WorkspaceUnchangedDocumentDiagnosticReport{}

===============================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/structures/workspace_unchanged_document_diagnostic_report.ex#L27 "View Source")

(struct)

[fields](#__struct__/0-fields)

 Fields

---------------------------------------

* uri: The URI for which diagnostic information is reported.

* version: The version number for which the diagnostics are reported.

If the document is not marked as open `null` can be provided.

* kind: A document diagnostic report indicating

no changes to the last result. A server can

only return `unchanged` if result ids are

provided.

* result\_id: A result id which will be sent on the next

diagnostic request for the same document.





GenLSP.Test — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L1 "View Source")

GenLSP.Test

(gen\_lsp v0.6.0)

================================================================================================================================================

Conveniences for testing GenLSP processes.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[client()](#t:client/0)

The test client data structure.

[server()](#t:server/0)

The test server data structure.

[Functions](#functions)

------------------------

[alive?(map)](#alive?/1)

Simple helper to determine whether the LSP process is alive.

[assert\_error(id, pattern, timeout \\ Application.get\_env(:ex\_unit, :assert\_receive\_timeout))](#assert_error/3)

Assert on the error response of a request that was sent with [`GenLSP.Test.request/2`](#request/2).

[assert\_notification(method, pattern, timeout \\ Application.get\_env(:ex\_unit, :assert\_receive\_timeout))](#assert_notification/3)

Assert on a notification that was sent from the server.

[assert\_request(client, method, timeout \\ Application.get\_env(:ex\_unit, :assert\_receive\_timeout), callback)](#assert_request/4)

Assert on a request that was sent from the server.

[assert\_result(id, pattern, timeout \\ Application.get\_env(:ex\_unit, :assert\_receive\_timeout))](#assert_result/3)

Assert on the successful response of a request that was sent with [`GenLSP.Test.request/2`](#request/2).

[client(server)](#client/1)

Starts a new LSP client for the given server.

[notify(map, body)](#notify/2)

Send a notification from the client to the server.

[request(map, body)](#request/2)

Send a request from the client to the server.

[server(mod, opts \\ [])](#server/2)

Starts a new server.

[Link to this section](#types)

Types

=====================================

[Link to this opaque](#t:client/0 "Link to this opaque")

client()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L18 "View Source")

(opaque)

```

@opaque client()

```

The test client data structure.

[Link to this opaque](#t:server/0 "Link to this opaque")

server()

========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L13 "View Source")

(opaque)

```

@opaque server()

```

The test server data structure.

[Link to this section](#functions)

Functions

=============================================

[Link to this function](#alive?/1 "Link to this function")

alive?(map)

===========

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L141 "View Source")

```

@spec alive?([server](#t:server/0)()) :: [boolean](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()

```

Simple helper to determine whether the LSP process is alive.

[Link to this macro](#assert_error/3 "Link to this macro")

assert\_error(id, pattern, timeout \\ Application.get\_env(:ex\_unit, :assert\_receive\_timeout))

=================================================================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L222 "View Source")

(macro)

Assert on the error response of a request that was sent with [`GenLSP.Test.request/2`](#request/2).

The second argument is a pattern, similar to [`ExUnit.Assertions.assert_receive/3`](https://hexdocs.pm/ex_unit/ExUnit.Assertions.html#assert_receive/3).

[usage](#assert_error/3-usage)

 Usage

--------------------------------------

```

import GenLSP.Test

id = 3

request(client, %{

 method: "textDocument/documentSymbol",

 id: id,

 jsonrpc: "2.0",

 params: %{

 textDocument: %{

 uri: "file://file/doesnt/matter.ex"

 }

 }

})

assert\_error(^id, %{

 "code" => -32601,

 "message" => "Method Not Found"

})

```

[Link to this macro](#assert_notification/3 "Link to this macro")

assert\_notification(method, pattern, timeout \\ Application.get\_env(:ex\_unit, :assert\_receive\_timeout))

============================================================================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L255 "View Source")

(macro)

Assert on a notification that was sent from the server.

The second argument is a pattern, similar to [`ExUnit.Assertions.assert_receive/3`](https://hexdocs.pm/ex_unit/ExUnit.Assertions.html#assert_receive/3).

[usage](#assert_notification/3-usage)

 Usage

---------------------------------------------

```

import GenLSP.Test

notify(client, %{method: "initialized", jsonrpc: "2.0", params: %{}})

assert\_notification("window/logMessage", %{

 "message" => "[MyLSP] LSP Initialized!",

 "type" => 4

})

```

[Link to this macro](#assert_request/4 "Link to this macro")

assert\_request(client, method, timeout \\ Application.get\_env(:ex\_unit, :assert\_receive\_timeout), callback)

================================================================================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L297 "View Source")

(macro)

Assert on a request that was sent from the server.

[usage](#assert_request/4-usage)

 Usage

----------------------------------------

```

assert\_request(client, "client/registerCapability", 1000, fn params ->

 assert params == %{

 "registrations" => [

 %{

 "id" => "file-watching",

 "method" => "workspace/didChangeWatchedFiles",

 "registerOptions" => %{

 "watchers" => [

 %{

 "globPattern" => "{lib|test}/\*\*/\*.{ex|exs|heex|eex|leex|surface}"

 }

 ]

 }

 }

 ]

 }

 nil

end)

```

[Link to this macro](#assert_result/3 "Link to this macro")

assert\_result(id, pattern, timeout \\ Application.get\_env(:ex\_unit, :assert\_receive\_timeout))

==================================================================================================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L178 "View Source")

(macro)

Assert on the successful response of a request that was sent with [`GenLSP.Test.request/2`](#request/2).

The second argument is a pattern, similar to [`ExUnit.Assertions.assert_receive/3`](https://hexdocs.pm/ex_unit/ExUnit.Assertions.html#assert_receive/3).

[usage](#assert_result/3-usage)

 Usage

---------------------------------------

```

import GenLSP.Test

id = 1

request(client, %{

 method: "initialize",

 id: id,

 jsonrpc: "2.0",

 params: %{capabilities: %{}, rootUri: "file://#{root\_path}"}

})

assert\_result(^id, %{

 "capabilities" => %{

 "textDocumentSync" => %{

 "openClose" => true,

 "save" => %{

 "includeText" => true

 },

 "change" => 1

 }

 },

 "serverInfo" => %{"name" => "Credo"}

})

```

[Link to this function](#client/1 "Link to this function")

client(server)

==============

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L58 "View Source")

```

@spec client([server](#t:server/0)()) :: [client](#t:client/0)()

```

Starts a new LSP client for the given server.

The "client" is equivalent to a text editor.

[usage](#client/1-usage)

 Usage

--------------------------------

```

import GenLSP.Test

server = server(MyLSP, some\_arg: some\_arg)

client = client(server)

```

[Link to this function](#notify/2 "Link to this function")

notify(map, body)

=================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L133 "View Source")

```

@spec notify([client](#t:client/0)(), [Jason.Encoder.t](https://hexdocs.pm/jason/1.3.0/Jason.Encoder.html#t:t/0)()) :: :ok

```

Send a notification from the client to the server.

[usage](#notify/2-usage)

 Usage

--------------------------------

```

import GenLSP.Test

notify(client, %{

 method: "initialized",

 jsonrpc: "2.0",

 params: %{}

})

```

[Link to this function](#request/2 "Link to this function")

request(map, body)

==================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L113 "View Source")

```

@spec request([client](#t:client/0)(), [Jason.Encoder.t](https://hexdocs.pm/jason/1.3.0/Jason.Encoder.html#t:t/0)()) ::

  {:ok, [any](https://hexdocs.pm/elixir/typespecs.html#basic-types)()} | {:error, :closed | {:timeout, [binary](https://hexdocs.pm/elixir/typespecs.html#built-in-types)()} | [:inet.posix](https://www.erlang.org/doc/man/inet.html#type-posix)()}

```

Send a request from the client to the server.

The response from the server will be sent as a message to the current process and can be asserted on using [`GenLSP.Test.assert_result/3`](#assert_result/3).

[usage](#request/2-usage)

 Usage

---------------------------------

```

import GenLSP.Test

request(client, %{

 method: "initialize",

 id: 1,

 jsonrpc: "2.0",

 params: %{capabilities: %{}, rootUri: "file://#{root\_path}"}

})

```

[Link to this function](#server/2 "Link to this function")

server(mod, opts \\ [])

=======================

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/test.ex#L32 "View Source")

Starts a new server.

[usage](#server/2-usage)

 Usage

--------------------------------

```

import GenLSP.Test

server = server(MyLSP, some\_arg: some\_arg)

```





GenLSP.TypeAlias.ChangeAnnotationIdentifier — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/change_annotation_identifier.ex#L2 "View Source")

GenLSP.TypeAlias.ChangeAnnotationIdentifier

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================================

An identifier to refer to a change annotation stored with a workspace edit.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/change_annotation_identifier.ex#L9 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```





GenLSP.TypeAlias.Declaration — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/declaration.ex#L2 "View Source")

GenLSP.TypeAlias.Declaration

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================

The declaration of a symbol representation as one or many {@link Location locations}.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/declaration.ex#L9 "View Source")

```

@type t() :: [GenLSP.Structures.Location.t](GenLSP.Structures.Location.html#t:t/0)() | [[GenLSP.Structures.Location.t](GenLSP.Structures.Location.html#t:t/0)()]

```





GenLSP.TypeAlias.DeclarationLink — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/declaration_link.ex#L2 "View Source")

GenLSP.TypeAlias.DeclarationLink

(gen\_lsp v0.6.0)

=======================================================================================================================================================================================================

Information about where a symbol is declared.

Provides additional metadata over normal {@link Location location} declarations, including the range of

the declaring symbol.

Servers should prefer returning `DeclarationLink` over `Declaration` if supported

by the client.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/declaration_link.ex#L15 "View Source")

```

@type t() :: [GenLSP.Structures.LocationLink.t](GenLSP.Structures.LocationLink.html#t:t/0)()

```





GenLSP.TypeAlias.Definition — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/definition.ex#L2 "View Source")

GenLSP.TypeAlias.Definition

(gen\_lsp v0.6.0)

============================================================================================================================================================================================

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.

Servers should prefer returning `DefinitionLink` over `Definition` if supported

by the client.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/definition.ex#L14 "View Source")

```

@type t() :: [GenLSP.Structures.Location.t](GenLSP.Structures.Location.html#t:t/0)() | [[GenLSP.Structures.Location.t](GenLSP.Structures.Location.html#t:t/0)()]

```





GenLSP.TypeAlias.DefinitionLink — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/definition_link.ex#L2 "View Source")

GenLSP.TypeAlias.DefinitionLink

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================

Information about where a symbol is defined.

Provides additional metadata over normal {@link Location location} definitions, including the range of

the defining symbol

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/definition_link.ex#L12 "View Source")

```

@type t() :: [GenLSP.Structures.LocationLink.t](GenLSP.Structures.LocationLink.html#t:t/0)()

```





GenLSP.TypeAlias.DocumentDiagnosticReport — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/document_diagnostic_report.ex#L2 "View Source")

GenLSP.TypeAlias.DocumentDiagnosticReport

(gen\_lsp v0.6.0)

==========================================================================================================================================================================================================================

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.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/document_diagnostic_report.ex#L15 "View Source")

```

@type t() ::

  [GenLSP.Structures.RelatedFullDocumentDiagnosticReport.t](GenLSP.Structures.RelatedFullDocumentDiagnosticReport.html#t:t/0)()

  | [GenLSP.Structures.RelatedUnchangedDocumentDiagnosticReport.t](GenLSP.Structures.RelatedUnchangedDocumentDiagnosticReport.html#t:t/0)()

```





GenLSP.TypeAlias.DocumentFilter — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/document_filter.ex#L2 "View Source")

GenLSP.TypeAlias.DocumentFilter

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================================

A document filter describes a top level text document or

a notebook cell document.

@since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/document_filter.ex#L12 "View Source")

```

@type t() ::

  [GenLSP.TypeAlias.TextDocumentFilter.t](GenLSP.TypeAlias.TextDocumentFilter.html#t:t/0)()

  | [GenLSP.Structures.NotebookCellTextDocumentFilter.t](GenLSP.Structures.NotebookCellTextDocumentFilter.html#t:t/0)()

```





GenLSP.TypeAlias.DocumentSelector — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/document_selector.ex#L2 "View Source")

GenLSP.TypeAlias.DocumentSelector

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================================

A document selector is the combination of one or many document filters.

@sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;

The use of a string as a document filter is deprecated @since 3.16.0.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/document_selector.ex#L13 "View Source")

```

@type t() :: [[GenLSP.TypeAlias.DocumentFilter.t](GenLSP.TypeAlias.DocumentFilter.html#t:t/0)()]

```





GenLSP.TypeAlias.GlobPattern — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/glob_pattern.ex#L2 "View Source")

GenLSP.TypeAlias.GlobPattern

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================

The glob pattern. Either a string pattern or a relative pattern.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/glob_pattern.ex#L11 "View Source")

```

@type t() :: [GenLSP.TypeAlias.Pattern.t](GenLSP.TypeAlias.Pattern.html#t:t/0)() | [GenLSP.Structures.RelativePattern.t](GenLSP.Structures.RelativePattern.html#t:t/0)()

```





GenLSP.TypeAlias.InlineValue — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/inline_value.ex#L2 "View Source")

GenLSP.TypeAlias.InlineValue

(gen\_lsp v0.6.0)

===============================================================================================================================================================================================

Inline value information can be provided by different means:

* directly as a text value (class InlineValueText).

* as a name to use for a variable lookup (class InlineValueVariableLookup)

* as an evaluatable expression (class InlineValueEvaluatableExpression)

The InlineValue types combines all inline value types into one type.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/inline_value.ex#L15 "View Source")

```

@type t() ::

  [GenLSP.Structures.InlineValueText.t](GenLSP.Structures.InlineValueText.html#t:t/0)()

  | [GenLSP.Structures.InlineValueVariableLookup.t](GenLSP.Structures.InlineValueVariableLookup.html#t:t/0)()

  | [GenLSP.Structures.InlineValueEvaluatableExpression.t](GenLSP.Structures.InlineValueEvaluatableExpression.html#t:t/0)()

```





GenLSP.TypeAlias.LSPAny — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/lsp_any.ex#L2 "View Source")

GenLSP.TypeAlias.LSPAny

(gen\_lsp v0.6.0)

=====================================================================================================================================================================================

The LSP any type.

Please note that strictly speaking a property with the value `undefined`

can't be converted into JSON preserving the property name. However for

convenience it is allowed and assumed that all these properties are

optional as well.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/lsp_any.ex#L14 "View Source")

```

@type t() :: [any](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

```





GenLSP.TypeAlias.LSPArray — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/lsp_array.ex#L2 "View Source")

GenLSP.TypeAlias.LSPArray

(gen\_lsp v0.6.0)

=========================================================================================================================================================================================

LSP arrays.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/lsp_array.ex#L10 "View Source")

```

@type t() :: [[any](https://hexdocs.pm/elixir/typespecs.html#basic-types)()]

```





GenLSP.TypeAlias.LSPObject — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/lsp_object.ex#L2 "View Source")

GenLSP.TypeAlias.LSPObject

(gen\_lsp v0.6.0)

===========================================================================================================================================================================================

LSP object definition.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/lsp_object.ex#L10 "View Source")

```

@type t() :: %{required([String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()) => [any](https://hexdocs.pm/elixir/typespecs.html#basic-types)()}

```





GenLSP.TypeAlias.MarkedString — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/marked_string.ex#L2 "View Source")

GenLSP.TypeAlias.MarkedString

(gen\_lsp v0.6.0)

=================================================================================================================================================================================================

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>

The pair of a language and a value is an equivalent to markdown:

```

${value}

```

Note that markdown strings will be sanitized - that means html will be escaped.

@deprecated use MarkupContent instead.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/marked_string.ex#L20 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

```





GenLSP.TypeAlias.NotebookDocumentFilter — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/notebook_document_filter.ex#L2 "View Source")

GenLSP.TypeAlias.NotebookDocumentFilter

(gen\_lsp v0.6.0)

======================================================================================================================================================================================================================

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)

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/notebook_document_filter.ex#L13 "View Source")

```

@type t() :: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

```





GenLSP.TypeAlias.Pattern — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/pattern.ex#L2 "View Source")

GenLSP.TypeAlias.Pattern

(gen\_lsp v0.6.0)

======================================================================================================================================================================================

The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:

* `*` to match one or more characters in a path segment

* `?` to match on one character in a path segment

* `**` to match any number of path segments, including none

* `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)

* `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)

* `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/pattern.ex#L17 "View Source")

```

@type t() :: [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```





GenLSP.TypeAlias.PrepareRenameResult — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/prepare_rename_result.ex#L2 "View Source")

GenLSP.TypeAlias.PrepareRenameResult

(gen\_lsp v0.6.0)

================================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/prepare_rename_result.ex#L5 "View Source")

```

@type t() :: [GenLSP.Structures.Range.t](GenLSP.Structures.Range.html#t:t/0)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

```





GenLSP.TypeAlias.ProgressToken — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/progress_token.ex#L2 "View Source")

GenLSP.TypeAlias.ProgressToken

(gen\_lsp v0.6.0)

===================================================================================================================================================================================================

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/progress_token.ex#L5 "View Source")

```

@type t() :: [integer](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [String.t](https://hexdocs.pm/elixir/String.html#t:t/0)()

```





GenLSP.TypeAlias.TextDocumentContentChangeEvent — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/text_document_content_change_event.ex#L2 "View Source")

GenLSP.TypeAlias.TextDocumentContentChangeEvent

(gen\_lsp v0.6.0)

========================================================================================================================================================================================================================================

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.

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/text_document_content_change_event.ex#L10 "View Source")

```

@type t() :: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

```





GenLSP.TypeAlias.TextDocumentFilter — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/text_document_filter.ex#L2 "View Source")

GenLSP.TypeAlias.TextDocumentFilter

(gen\_lsp v0.6.0)

==============================================================================================================================================================================================================

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

Glob patterns can have the following syntax:

* `*` to match one or more characters in a path segment

* `?` to match on one character in a path segment

* `**` to match any number of path segments, including none

* `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)

* `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)

* `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)

@sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`

@sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/text_document_filter.ex#L24 "View Source")

```

@type t() :: [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)() | [map](https://hexdocs.pm/elixir/typespecs.html#basic-types)()

```





GenLSP.TypeAlias.WorkspaceDocumentDiagnosticReport — gen\_lsp v0.6.0

 try {

 var settings = JSON.parse(localStorage.getItem('ex\_doc:settings') || '{}');

 if (settings.theme === 'dark' ||

 ((settings.theme === 'system' || settings.theme == null) &&

 window.matchMedia('(prefers-color-scheme: dark)').matches)

 ) {

 document.body.classList.add('dark')

 }

 } catch (error) { }

 

Settings

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/workspace_document_diagnostic_report.ex#L2 "View Source")

GenLSP.TypeAlias.WorkspaceDocumentDiagnosticReport

(gen\_lsp v0.6.0)

=============================================================================================================================================================================================================================================

A workspace diagnostic document report.

@since 3.17.0

[Link to this section](#summary)

 Summary

==========================================

[Types](#types)

----------------

[t()](#t:t/0)

[Link to this section](#types)

Types

=====================================

[Link to this type](#t:t/0 "Link to this type")

t()

===

[View Source](https://github.com/elixir-tools/gen_lsp/blob/main/lib/gen_lsp/protocol/type_aliases/workspace_document_diagnostic_report.ex#L11 "View Source")

```

@type t() ::

  [GenLSP.Structures.WorkspaceFullDocumentDiagnosticReport.t](GenLSP.Structures.WorkspaceFullDocumentDiagnosticReport.html#t:t/0)()

  | [GenLSP.Structures.WorkspaceUnchangedDocumentDiagnosticReport.t](GenLSP.Structures.WorkspaceUnchangedDocumentDiagnosticReport.html#t:t/0)()

```

