Struct lsp::types::SymbolInformation

pub struct SymbolInformation {
    pub name: String,
    pub kind: SymbolKind,
    pub deprecated: Option<bool>,
    pub location: Location,
    pub container_name: Option<String>,
}

Represents information about programming constructs like variables, classes, interfaces etc.

Fields

name: String

The name of this symbol.

kind: SymbolKind

The kind of this symbol.

deprecated: Option<bool>

Indicates if this symbol is deprecated.

location: 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 thinks like visibility modifiers.

The range doesn't have to denote a node range in the sense of a abstract syntax tree. It can therefore not be used to re-construct a hierarchy of the symbols.

container_name: Option<String>

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.

Methods

impl SymbolInformation

pub fn create(     name: String,     kind: SymbolKind,     range: Range,     uri: Option<String>,     container_name: Option<String> ) -> Self

Creates a new symbol information literal.

@param name The name of the symbol. @param kind The kind of the symbol. @param range The range of the location of the symbol. @param uri The resource of the location of symbol, defaults to the current document. @param containerName The name of the symbol containing the symbol.

Trait Implementations

impl Debug for SymbolInformation

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.