Struct DocumentOutline 

pub struct DocumentOutline {
    pub symbols: Vec<DocumentSymbol>,
}

A document outline (top-level symbol list).

Fields

symbols: Vec<DocumentSymbol>

Top-level symbols.

Implementations

impl DocumentOutline

pub fn new(symbols: Vec<DocumentSymbol>) -> Self

Create a new outline.

pub fn is_empty(&self) -> bool

Returns true if there are no symbols.

pub fn top_level_count(&self) -> usize

Return the top-level symbol count.

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

Flatten all symbols in pre-order.

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

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

Trait Implementations

impl Clone for DocumentOutline

fn clone(&self) -> DocumentOutline

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentOutline

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

Formats the value using the given formatter.

impl Default for DocumentOutline

fn default() -> DocumentOutline

Returns the “default value” for a type.

impl Eq for DocumentOutline

impl PartialEq for DocumentOutline

fn eq(&self, other: &DocumentOutline) -> 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 DocumentOutline