Struct notedown_ast::utils::lsp_types::DocumentSymbol [−]
pub struct DocumentSymbol {
pub name: String,
pub detail: Option<String>,
pub kind: SymbolKind,
pub tags: Option<Vec<SymbolTag, Global>>,
pub deprecated: Option<bool>,
pub range: Range,
pub selection_range: Range,
pub children: Option<Vec<DocumentSymbol, Global>>,
}
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, Global>>
Children of this symbol, e.g. properties of a class.
Trait Implementations
impl Clone for DocumentSymbol
impl Clone for DocumentSymbol
pub fn clone(&self) -> DocumentSymbol
pub fn clone(&self) -> DocumentSymbol
Returns a copy of the value. Read more
Performs copy-assignment from source
. Read more
impl Debug for DocumentSymbol
impl Debug for DocumentSymbol
impl<'de> Deserialize<'de> for DocumentSymbol
impl<'de> Deserialize<'de> for DocumentSymbol
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<DocumentSymbol, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<DocumentSymbol, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl PartialEq<DocumentSymbol> for DocumentSymbol
impl PartialEq<DocumentSymbol> for DocumentSymbol
pub fn eq(&self, other: &DocumentSymbol) -> bool
pub fn eq(&self, other: &DocumentSymbol) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
pub fn ne(&self, other: &DocumentSymbol) -> bool
pub fn ne(&self, other: &DocumentSymbol) -> bool
This method tests for !=
.
impl Serialize for DocumentSymbol
impl Serialize for DocumentSymbol
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
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
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.