Struct DocumentSymbol 

pub struct DocumentSymbol {
    pub name: String,
    pub detail: Option<String>,
    pub kind: SymbolKind,
    pub range: SymbolRange,
    pub selection_range: SymbolRange,
    pub children: Vec<DocumentSymbol>,
    pub data_json: Option<String>,
}

A single document symbol node (hierarchical).

Fields

name: String

Symbol name (e.g. function name).

detail: Option<String>

Optional detail string (e.g. type signature).

kind: SymbolKind

Symbol kind.

range: SymbolRange

Full symbol span (character offsets).

selection_range: SymbolRange

Selection span (character offsets).

children: Vec<DocumentSymbol>

Child symbols.

data_json: Option<String>

Optional raw integration payload, encoded as JSON text.

Implementations

impl DocumentSymbol

pub fn flatten_preorder<'a>(&'a self, out: &mut Vec<&'a DocumentSymbol>)

Collect this node and all descendants in pre-order.

pub fn find_by_name<'a>(&'a self, name: &str, out: &mut Vec<&'a DocumentSymbol>)

Find all symbols with the given name (pre-order).

Trait Implementations

impl Clone for DocumentSymbol

fn clone(&self) -> DocumentSymbol

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentSymbol

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

Formats the value using the given formatter.

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 Eq for DocumentSymbol

impl StructuralPartialEq for DocumentSymbol