Packages

gen_lsp

0.11.2
0.11.3 0.11.2 0.11.1 0.11.0 0.10.0 0.9.0 0.8.1 0.8.0 0.7.3 0.7.2 0.7.1 0.7.0 0.6.3 0.6.2 0.6.1 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.2.0 0.1.2 0.1.1 0.1.0 0.0.12 0.0.11 0.0.10 0.0.9 0.0.8 0.0.7 0.0.6 0.0.5 0.0.4 0.0.3 0.0.2 0.0.1

Library for creating language servers

HexDocs

Current section

Files

Jump to
Readme
36 Versions
4 Dependencies
Dependants
Files
Activity
gen_lsp lib gen_lsp protocol structures hover.ex
Raw

lib/gen_lsp/protocol/structures/hover.ex 

# codegen: do not edit

defmodule GenLSP.Structures.Hover do

  @moduledoc """

  The result of a hover request.

  """



  import Schematic, warn: false



  use TypedStruct



  @doc """

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

  """

  @derive Jason.Encoder

  typedstruct do

    field :contents,

          GenLSP.Structures.MarkupContent.t()

          | GenLSP.TypeAlias.MarkedString.t()

          | list(GenLSP.TypeAlias.MarkedString.t()),

          enforce: true



    field :range, GenLSP.Structures.Range.t()

  end



  @doc false

  @spec schema() :: Schematic.t()

  def schema() do

    schema(__MODULE__, %{

      {"contents", :contents} =>

        oneof([

          GenLSP.Structures.MarkupContent.schema(),

          GenLSP.TypeAlias.MarkedString.schema(),

          list(GenLSP.TypeAlias.MarkedString.schema())

        ]),

      optional({"range", :range}) => GenLSP.Structures.Range.schema()

    })

  end

end