Struct lsp_types::WorkspaceSymbol

pub struct WorkspaceSymbol {
    pub name: String,
    pub kind: SymbolKind,
    pub tags: Option<Vec<SymbolTag>>,
    pub container_name: Option<String>,
    pub location: OneOf<Location, WorkspaceLocation>,
    pub data: Option<LSPAny>,
}

A special workspace symbol that supports locations without a range

@since 3.17.0

Fields

name: String

The name of this symbol.

kind: SymbolKind

The kind of this symbol.

tags: Option<Vec<SymbolTag>>

Tags for this completion item.

container_name: Option<String>

The name of the symbol containing this symbol. This information is for user interface purposes (e.g. to render a qualifier in the user interface if necessary). It can’t be used to re-infer a hierarchy for the document symbols.

location: OneOf<Location, WorkspaceLocation>

The location of this symbol. Whether a server is allowed to return a location without a range depends on the client capability workspace.symbol.resolveSupport.

See also SymbolInformation.location.

data: Option<LSPAny>

A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.

Trait Implementations

impl Clone for WorkspaceSymbol

fn clone(&self) -> WorkspaceSymbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceSymbol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkspaceSymbol

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<WorkspaceSymbol> for WorkspaceSymbol

fn eq(&self, other: &WorkspaceSymbol) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WorkspaceSymbol

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
__S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for WorkspaceSymbol

impl StructuralEq for WorkspaceSymbol

impl StructuralPartialEq for WorkspaceSymbol