Struct ScipSymbol

pub struct ScipSymbol {
    pub symbol: String,
    pub name: String,
    pub kind: SymbolKind,
    pub range: Range<usize>,
    pub selection_range: Range<usize>,
    pub signature: Option<String>,
    pub docs: Option<String>,
}

Imported SCIP symbol descriptor.

Examples

use ailloli_ui_editor::{ScipSymbol, SymbolKind};
let symbol = ScipSymbol { symbol: "pkg/foo#".into(), name: "foo".into(), kind: SymbolKind::Function, range: 0..8, selection_range: 3..6, signature: None, docs: None };
assert_eq!(symbol.name, "foo");

Fields

symbol: String

Canonical SCIP symbol string used to resolve relations/occurrences.

name: String

Human-readable symbol name.

kind: SymbolKind

Language-neutral symbol category.

range: Range<usize>

Unvalidated half-open full extent in document UTF-8 bytes.

selection_range: Range<usize>

Unvalidated half-open name range in document UTF-8 bytes.

signature: Option<String>

Optional exact signature; None differs from an empty signature.

docs: Option<String>

Optional exact documentation; None differs from empty documentation.

Trait Implementations

impl Clone for ScipSymbol

fn clone(&self) -> ScipSymbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScipSymbol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScipSymbol

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScipSymbol

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

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 ScipSymbol

impl StructuralPartialEq for ScipSymbol