Struct SemanticDocumentSymbol

pub struct SemanticDocumentSymbol {
    pub name: String,
    pub kind: SymbolKind,
    pub range: Range<usize>,
    pub selection_range: Range<usize>,
    pub detail: Option<String>,
    pub source: SymbolSource,
}

Language-server/SCIP symbol payload before conversion to local symbol IR.

Ranges are unvalidated UTF-8 byte offsets. detail typically contains a signature, while None means the backend supplied no detail.

Examples

use ailloli_ui_editor::{code::SemanticDocumentSymbol, SymbolKind, SymbolSource};
let symbol = SemanticDocumentSymbol { name: "run".into(), kind: SymbolKind::Function, range: 0..8, selection_range: 3..6, detail: None, source: SymbolSource::Lsp };
assert_eq!(symbol.selection_range, 3..6);

Fields

name: String

Display name, including an empty name if supplied by the backend.

kind: SymbolKind

Language-neutral symbol category.

range: Range<usize>

Half-open extent in document UTF-8 bytes.

selection_range: Range<usize>

Half-open name/selection range in document UTF-8 bytes.

detail: Option<String>

Optional backend detail copied into the local signature field.

source: SymbolSource

Claimed semantic source; conversion functions override this field.

Trait Implementations

impl Clone for SemanticDocumentSymbol

fn clone(&self) -> SemanticDocumentSymbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SemanticDocumentSymbol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SemanticDocumentSymbol

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SemanticDocumentSymbol

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

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 SemanticDocumentSymbol

impl StructuralPartialEq for SemanticDocumentSymbol