Struct DocumentSymbol

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.

Trait Implementations

impl Debug for DocumentSymbol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentSymbol

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DocumentSymbol

fn eq(&self, other: &DocumentSymbol) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DocumentSymbol

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DocumentSymbol

impl StructuralPartialEq for DocumentSymbol