Struct CodeFileSummary

pub struct CodeFileSummary {
    pub document_id: DocumentId,
    pub path: Option<PathBuf>,
    pub language: EditorLanguage,
    pub version: DocumentVersion,
    pub symbols: Vec<CodeSymbol>,
    pub edges: Vec<SymbolEdge>,
}

Complete symbol graph for one document version.

Examples

use ailloli_ui_editor::{CodeFileSummary, DocumentId, DocumentVersion, EditorLanguage};
let summary = CodeFileSummary { document_id: DocumentId(1), path: None, language: EditorLanguage::Rust, version: DocumentVersion(0), symbols: vec![], edges: vec![] };
assert!(summary.symbols.is_empty() && summary.edges.is_empty());

Fields

document_id: DocumentId

Document identity copied from the indexed document or supplied by caller.

path: Option<PathBuf>

Optional document path.

language: EditorLanguage

Document language.

version: DocumentVersion

Document version represented by the graph.

symbols: Vec<CodeSymbol>

Symbols in stable indexer-defined order.

edges: Vec<SymbolEdge>

Directed, normally normalized graph edges.

Implementations

impl CodeFileSummary

Serializes symbol summaries for storage and inspection.

pub fn to_json_pretty(&self) -> Result<String>

Returns pretty-printed JSON containing every summary field.

Errors

Propagates a Serde JSON serialization error. Current fields are ordinary serializable values, so errors are not expected in normal use.

Examples

use ailloli_ui_editor::{CodeFileSummary, DocumentId, DocumentVersion, EditorLanguage};
let summary = CodeFileSummary { document_id: DocumentId(1), path: None, language: EditorLanguage::Rust, version: DocumentVersion(0), symbols: vec![], edges: vec![] };
let json = summary.to_json_pretty().unwrap();
assert!(json.contains("\"symbols\": []"));

Trait Implementations

impl Clone for CodeFileSummary

fn clone(&self) -> CodeFileSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeFileSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CodeFileSummary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CodeFileSummary

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

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 CodeFileSummary

impl StructuralPartialEq for CodeFileSummary