gen_lsp v0.8.1

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

A special workspace symbol that supports locations without a range.

See also SymbolInformation.

@since 3.17.0

Link to this section Summary

Types

t()

Functions

%GenLSP.Structures.WorkspaceSymbol{}

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

Link to this type

t()

View Source 
@type t() :: %GenLSP.Structures.WorkspaceSymbol{
  container_name: String.t() | nil,
  data: GenLSP.TypeAlias.LSPAny.t() | nil,
  kind: GenLSP.Enumerations.SymbolKind.t(),
  location: GenLSP.Structures.Location.t() | map(),
  name: String.t(),
  tags: [GenLSP.Enumerations.SymbolTag.t()] | nil
}

Link to this section Functions

Link to this function

%GenLSP.Structures.WorkspaceSymbol{}

View Source (struct)

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.