Struct Symbol 

pub struct Symbol {

    pub name: String,
    pub qualified_name: String,
    pub kind: SymbolKind,
    pub signature: String,
    pub visibility: Visibility,
    pub file_path: String,
    pub line_start: usize,
    pub line_end: usize,
    pub doc_comment: Option<String>,
    pub parent: Option<String>,
    pub parameters: Vec<Parameter>,
    pub return_type: Option<String>,
    pub is_async: bool,
    pub attributes: Vec<String>,
    pub throws: Vec<String>,
    pub generic_params: Option<String>,
    pub is_abstract: bool,
}

A code symbol extracted from source.

Fields

name: String

Simple name (e.g., “add”).

qualified_name: String

Fully qualified name (e.g., “module::Struct::method”).

kind: SymbolKind

What kind of symbol this is.

signature: String

Full signature text (up to the opening brace or the whole item for short items).

visibility: Visibility

Visibility of the symbol.

file_path: String

File path where the symbol is defined.

line_start: usize

0-based starting line number.

line_end: usize

0-based ending line number.

doc_comment: Option<String>

Documentation comment, if any (e.g., /// or //! in Rust).

parent: Option<String>

Qualified name of the parent symbol (e.g., struct name for a method).

parameters: Vec<Parameter>

Extracted parameters for functions/methods.

return_type: Option<String>

Return type annotation, if present.

is_async: bool

Whether this is an async function/method.

attributes: Vec<String>

Attributes, decorators, or annotations (e.g., #[derive(Debug)], @Override).

throws: Vec<String>

Error/exception types this symbol can throw.

generic_params: Option<String>

Generic type parameters (e.g., <T: Display>).

is_abstract: bool

Whether this is an abstract method (trait/interface method without body).

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Symbol

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Symbol

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.