pub struct SymbolEntry {Show 21 fields
pub name: String,
pub qualified_name: String,
pub symbol_type: SymbolType,
pub file: String,
pub lines: [usize; 2],
pub exported: bool,
pub signature: Option<String>,
pub summary: Option<String>,
pub purpose: Option<String>,
pub constraints: Option<SymbolConstraint>,
pub async_fn: bool,
pub visibility: Visibility,
pub calls: Vec<String>,
pub called_by: Vec<String>,
pub git: Option<GitSymbolInfo>,
pub annotations: HashMap<String, AnnotationProvenance>,
pub behavioral: Option<BehavioralAnnotations>,
pub lifecycle: Option<LifecycleAnnotations>,
pub documentation: Option<DocumentationAnnotations>,
pub performance: Option<PerformanceAnnotations>,
pub type_info: Option<TypeInfo>,
}Expand description
@acp:summary “Symbol entry with metadata (RFC-001 compliant)”
Fields§
§name: StringSimple symbol name (required)
qualified_name: StringQualified name: file_path:class.symbol (required)
symbol_type: SymbolTypeSymbol type (required)
file: StringContaining file path (required)
lines: [usize; 2][start_line, end_line] (required)
exported: boolWhether exported (required)
signature: Option<String>Function signature (optional)
summary: Option<String>Brief description (optional)
purpose: Option<String>RFC-001: Symbol purpose from @acp:fn/@acp:class/@acp:method directive
constraints: Option<SymbolConstraint>RFC-001: Symbol-level constraints
async_fn: boolWhether async (optional, default false)
visibility: VisibilitySymbol visibility (optional, default public)
calls: Vec<String>Symbols this calls (optional)
called_by: Vec<String>Symbols calling this (optional)
git: Option<GitSymbolInfo>Git metadata (optional - last commit, author, code age)
annotations: HashMap<String, AnnotationProvenance>RFC-0003: Annotation provenance tracking
behavioral: Option<BehavioralAnnotations>RFC-0009: Behavioral characteristics
lifecycle: Option<LifecycleAnnotations>RFC-0009: Lifecycle status
documentation: Option<DocumentationAnnotations>RFC-0009: Documentation metadata
performance: Option<PerformanceAnnotations>RFC-0009: Performance characteristics
type_info: Option<TypeInfo>RFC-0008: Type annotation information
Trait Implementations§
Source§impl Clone for SymbolEntry
impl Clone for SymbolEntry
Source§fn clone(&self) -> SymbolEntry
fn clone(&self) -> SymbolEntry
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for SymbolEntry
impl Debug for SymbolEntry
Source§impl<'de> Deserialize<'de> for SymbolEntry
impl<'de> Deserialize<'de> for SymbolEntry
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for SymbolEntry
impl RefUnwindSafe for SymbolEntry
impl Send for SymbolEntry
impl Sync for SymbolEntry
impl Unpin for SymbolEntry
impl UnwindSafe for SymbolEntry
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more