Struct DocumentSymbol

Source

pub struct DocumentSymbol {
    pub name: Arc<str>,
    pub kind: DocumentSymbolKind,
    pub location: Option<Location>,
    pub children: Vec<DocumentSymbol>,
}

Expand description

One declaration emitted by crate::AnalysisSession::document_symbols. Tool-agnostic shape for outline / breadcrumb features; consumers map this onto whatever protocol-specific symbol type they need.

Forms a tree: classes/interfaces/traits/enums have children populated with their methods, properties, and constants. Top-level functions and constants have empty children.

Fields§

§name: Arc<str>

FQCN for classes/interfaces/traits/enums; FQN for functions / constants; short name for members nested inside a class.

§kind: DocumentSymbolKind

Coarse kind suitable for icon / severity selection in outlines.

§location: Option<Location>

Source location of the declaration (file + 1-based lines, 0-based columns). None only for synthetic stub-only definitions that don’t have a recorded source span.

§children: Vec<DocumentSymbol>

For container symbols (Class, Interface, Trait, Enum), the nested methods, properties, and constants declared on this type. Empty for leaf kinds (Function, Constant, etc.).

DocumentSymbol

Struct DocumentSymbol Copy item path

Fields§

Trait Implementations§

impl Clone for DocumentSymbol

fn clone(&self) -> DocumentSymbol

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

impl Debug for DocumentSymbol

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

Auto Trait Implementations§

impl Freeze for DocumentSymbol

impl RefUnwindSafe for DocumentSymbol

impl Send for DocumentSymbol

impl Sync for DocumentSymbol

impl Unpin for DocumentSymbol

impl UnsafeUnpin for DocumentSymbol

impl UnwindSafe for DocumentSymbol

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T> Lookup<T> for T

fn into_owned(self) -> T

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

fn white(&self) -> FgColorDisplay<'_, White, Self>

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

fn bold(&self) -> BoldDisplay<'_, Self>

Struct DocumentSymbol

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,