Struct lsp::types::DocumentSymbol [−][src]
pub struct DocumentSymbol { pub name: String, pub detail: Option<String>, pub kind: SymbolKind, pub deprecated: Option<bool>, pub range: Range, pub selection_range: Range, pub children: Option<Vec<DocumentSymbol>>, }
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.
Fields
name: String
The name of this symbol.
detail: Option<String>
More detail for this symbol, e.g the signature of a function. If not provided the name is used.
kind: SymbolKind
The kind of this symbol.
deprecated: Option<bool>
Indicates if this symbol is deprecated.
range: 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 the clients cursor is inside the symbol to reveal in the symbol in the UI.
selection_range: 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 the range
.
children: Option<Vec<DocumentSymbol>>
Children of this symbol, e.g. properties of a class.
Methods
impl DocumentSymbol
[src]
impl DocumentSymbol
pub fn create(
name: String,
detail: Option<String>,
kind: SymbolKind,
range: Range,
selection_range: Range,
children: Option<Vec<DocumentSymbol>>
) -> Self
[src]
pub fn create(
name: String,
detail: Option<String>,
kind: SymbolKind,
range: Range,
selection_range: Range,
children: Option<Vec<DocumentSymbol>>
) -> Self
Creates a new symbol information literal.
@param name The name of the symbol. @param detail The detail of the symbol. @param kind The kind of the symbol. @param range The range of the symbol. @param selectionRange The selectionRange of the symbol. @param children Children of the symbol.
Trait Implementations
impl Debug for DocumentSymbol
[src]
impl Debug for DocumentSymbol
Auto Trait Implementations
impl Send for DocumentSymbol
impl Send for DocumentSymbol
impl Sync for DocumentSymbol
impl Sync for DocumentSymbol