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>,
}Expand description
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: DocumentIdDocument identity copied from the indexed document or supplied by caller.
path: Option<PathBuf>Optional document path.
language: EditorLanguageDocument language.
version: DocumentVersionDocument 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.
impl CodeFileSummary
Serializes symbol summaries for storage and inspection.
pub fn to_json_pretty(&self) -> Result<String, Error>
pub fn to_json_pretty(&self) -> Result<String, Error>
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
impl Clone for CodeFileSummary
§fn clone(&self) -> CodeFileSummary
fn clone(&self) -> CodeFileSummary
Returns a copy of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read more§impl Debug for CodeFileSummary
impl Debug for CodeFileSummary
§impl<'de> Deserialize<'de> for CodeFileSummary
impl<'de> Deserialize<'de> for CodeFileSummary
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<CodeFileSummary, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<CodeFileSummary, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
§impl PartialEq for CodeFileSummary
impl PartialEq for CodeFileSummary
§impl Serialize for CodeFileSummary
impl Serialize for CodeFileSummary
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl Eq for CodeFileSummary
impl StructuralPartialEq for CodeFileSummary
Auto Trait Implementations§
impl Freeze for CodeFileSummary
impl RefUnwindSafe for CodeFileSummary
impl Send for CodeFileSummary
impl Sync for CodeFileSummary
impl Unpin for CodeFileSummary
impl UnwindSafe for CodeFileSummary
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<A> IntoClickAction<A> for Awhere
A: Clone + 'static,
impl<A> IntoClickAction<A> for Awhere
A: Clone + 'static,
§fn into_click_action(self) -> ClickAction<A>
fn into_click_action(self) -> ClickAction<A>
Implements the into_click_action helper used by this module.