Struct DocumentSymbol 

pub struct DocumentSymbol {
    pub name: String,
    pub kind: SymbolKind,
    pub full_span: Span,
    pub name_span: Span,
    pub children: Vec<DocumentSymbol>,
}

A symbol in the document symbol outline (for IDE sidebar).

Fields

name: String

The name of the symbol.

kind: SymbolKind

The kind of symbol.

full_span: Span

The span of the entire declaration.

name_span: Span

The span of just the name.

children: Vec<DocumentSymbol>

Child symbols (e.g. structure fields, inductive constructors).

Implementations

impl DocumentSymbol

pub fn new( name: String, kind: SymbolKind, full_span: Span, name_span: Span, ) -> Self

Create a new document symbol.

pub fn add_child(&mut self, child: DocumentSymbol)

Add a child symbol.

pub fn has_children(&self) -> bool

Whether this symbol has children.

pub fn find_by_name(&self, name: &str) -> Option<&DocumentSymbol>

Recursively find a symbol by name.

pub fn flatten(&self) -> Vec<&DocumentSymbol>

Flatten into a list (self first, then children recursively).

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