Struct ScipDocumentIndex

pub struct ScipDocumentIndex {
    pub path: String,
    pub language: EditorLanguage,
    pub version: DocumentVersion,
    pub symbols: Vec<ScipSymbol>,
    pub occurrences: Vec<ScipOccurrence>,
    pub relations: Vec<ScipRelation>,
}

One imported SCIP document and its local semantic records.

Ranges throughout are unvalidated UTF-8 byte offsets. Symbol relations are resolved only against this document; occurrences additionally drive cross-document navigation.

Examples

use ailloli_ui_editor::{DocumentVersion, EditorLanguage, ScipDocumentIndex};
let document = ScipDocumentIndex { path: "src/lib.rs".into(), language: EditorLanguage::Rust, version: DocumentVersion(1), symbols: vec![], occurrences: vec![], relations: vec![] };
assert_eq!(document.language, EditorLanguage::Rust);

Fields

path: String

Opaque project-relative or absolute path string.

language: EditorLanguage

Language attached by the index producer.

version: DocumentVersion

Producer-supplied document version.

symbols: Vec<ScipSymbol>

Definitions/descriptors in positional-ID order.

occurrences: Vec<ScipOccurrence>

Definition/reference occurrences used for navigation.

relations: Vec<ScipRelation>

Local symbol-name relations used for graph edges.

Trait Implementations

impl Clone for ScipDocumentIndex

fn clone(&self) -> ScipDocumentIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScipDocumentIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScipDocumentIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScipDocumentIndex

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

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 ScipDocumentIndex

impl StructuralPartialEq for ScipDocumentIndex