Struct CodeSymbol

pub struct CodeSymbol {
    pub id: SymbolId,
    pub name: String,
    pub kind: SymbolKind,
    pub language: EditorLanguage,
    pub range: Range<usize>,
    pub selection_range: Range<usize>,
    pub parent: Option<SymbolId>,
    pub signature: Option<String>,
    pub docs: Option<String>,
    pub source: SymbolSource,
}

Language-neutral symbol record for one code document.

Ranges are half-open UTF-8 byte offsets. Built-in indexers keep them within the document, but this public value type performs no validation.

Examples

use ailloli_ui_editor::{CodeSymbol, EditorLanguage, SymbolId, SymbolKind, SymbolSource};
let symbol = CodeSymbol { id: SymbolId(1), name: "run".into(), kind: SymbolKind::Function, language: EditorLanguage::Rust, range: 0..10, selection_range: 3..6, parent: None, signature: Some("fn run()".into()), docs: None, source: SymbolSource::Lexical };
assert_eq!(symbol.selection_range, 3..6);

Fields

id: SymbolId

Summary-local identifier; zero conventionally denotes the document root.

name: String

Human-readable symbol name.

kind: SymbolKind

Language-neutral category.

language: EditorLanguage

Language inherited from the indexed document.

range: Range<usize>

Half-open full declaration extent in UTF-8 bytes.

selection_range: Range<usize>

Half-open name/selection extent in UTF-8 bytes.

parent: Option<SymbolId>

Optional containing symbol ID; None means document root.

signature: Option<String>

Optional compact declaration signature.

docs: Option<String>

Optional extracted documentation text.

source: SymbolSource

Indexer/enrichment provenance.

Trait Implementations

impl Clone for CodeSymbol

fn clone(&self) -> CodeSymbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeSymbol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CodeSymbol

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CodeSymbol

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

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 CodeSymbol

impl StructuralPartialEq for CodeSymbol