clang::clangd::SymbolDetails Struct Reference

Represents information about identifier. More...

#include <Protocol.h>

Public Attributes
std::string	name
std::string	containerName
std::string	USR
	Unified Symbol Resolution identifier This is an opaque string uniquely identifying a symbol.
SymbolID	ID
std::optional< Location >	declarationRange
std::optional< Location >	definitionRange

Detailed Description

Represents information about identifier.

This is returned from textDocument/symbolInfo, which is a clangd extension.

Definition at line 1164 of file Protocol.h.

Member Data Documentation

containerName

std::string clang::clangd::SymbolDetails::containerName

Definition at line 1167 of file Protocol.h.

Referenced by clang::clangd::getSymbolInfo(), clang::clangd::operator<<(), clang::clangd::operator==(), and clang::clangd::toJSON().

declarationRange

std::optional<Location> clang::clangd::SymbolDetails::declarationRange

Definition at line 1178 of file Protocol.h.

Referenced by clang::clangd::getSymbolInfo(), clang::clangd::operator==(), and clang::clangd::toJSON().

definitionRange

std::optional<Location> clang::clangd::SymbolDetails::definitionRange

Definition at line 1180 of file Protocol.h.

Referenced by clang::clangd::getSymbolInfo(), clang::clangd::operator==(), and clang::clangd::toJSON().

ID

SymbolID clang::clangd::SymbolDetails::ID

Definition at line 1176 of file Protocol.h.

Referenced by clang::clangd::getSymbolInfo(), clang::clangd::operator==(), and clang::clangd::toJSON().

name

std::string clang::clangd::SymbolDetails::name

Definition at line 1165 of file Protocol.h.

Referenced by clang::clangd::getSymbolInfo(), clang::clangd::operator<<(), clang::clangd::operator==(), and clang::clangd::toJSON().

USR

std::string clang::clangd::SymbolDetails::USR

Unified Symbol Resolution identifier This is an opaque string uniquely identifying a symbol.

Unlike SymbolID, it is variable-length and somewhat human-readable. It is a common representation across several clang tools. (See USRGeneration.h)

Definition at line 1174 of file Protocol.h.

Referenced by clang::clangd::getSymbolInfo(), clang::clangd::operator==(), and clang::clangd::toJSON().

---

The documentation for this struct was generated from the following file:

• Protocol.h