Struct lsp_types::DocumentSymbol
source · [−]pub struct DocumentSymbol {
pub name: String,
pub detail: Option<String>,
pub kind: SymbolKind,
pub tags: Option<Vec<SymbolTag>>,
pub deprecated: Option<bool>,
pub range: Range,
pub selection_range: Range,
pub children: Option<Vec<DocumentSymbol>>,
}
Expand description
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.
Tags for this completion item. since 3.16.0
deprecated: Option<bool>
Use tags instead
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
sourceimpl Clone for DocumentSymbol
impl Clone for DocumentSymbol
sourcefn clone(&self) -> DocumentSymbol
fn clone(&self) -> DocumentSymbol
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for DocumentSymbol
impl Debug for DocumentSymbol
sourceimpl<'de> Deserialize<'de> for DocumentSymbol
impl<'de> Deserialize<'de> for DocumentSymbol
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<DocumentSymbol> for DocumentSymbol
impl PartialEq<DocumentSymbol> for DocumentSymbol
sourcefn eq(&self, other: &DocumentSymbol) -> bool
fn eq(&self, other: &DocumentSymbol) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DocumentSymbol) -> bool
fn ne(&self, other: &DocumentSymbol) -> bool
This method tests for !=
.
sourceimpl Serialize for DocumentSymbol
impl Serialize for DocumentSymbol
impl Eq for DocumentSymbol
impl StructuralEq for DocumentSymbol
impl StructuralPartialEq for DocumentSymbol
Auto Trait Implementations
impl RefUnwindSafe for DocumentSymbol
impl Send for DocumentSymbol
impl Sync for DocumentSymbol
impl Unpin for DocumentSymbol
impl UnwindSafe for DocumentSymbol
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more