Struct Symbol 

pub struct Symbol {

    pub id: String,
    pub name: String,
    pub kind: SymbolKind,
    pub file_path: String,
    pub start_line: u32,
    pub end_line: u32,
    pub start_byte: u32,
    pub end_byte: u32,
    pub parent_id: Option<String>,
    pub signature: Option<String>,
    pub visibility: Visibility,
    pub is_async: bool,
    pub docstring: Option<String>,
    pub in_degree: u32,
    pub content_hash: Option<String>,
    pub subtree_hash: Option<String>,
}

Fields

id: String

name: String

kind: SymbolKind

file_path: String

start_line: u32

end_line: u32

start_byte: u32

end_byte: u32

parent_id: Option<String>

signature: Option<String>

visibility: Visibility

is_async: bool

docstring: Option<String>

in_degree: u32

content_hash: Option<String>

subtree_hash: Option<String>

Implementations

impl Symbol

pub fn new( name: impl Into<String>, kind: SymbolKind, file_path: &str, start_line: u32, end_line: u32, start_byte: u32, end_byte: u32, parent_name: Option<&str>, ) -> Self

Create a new symbol with a stable ID: file_path:kind:qualified_name.

parent_name is the unqualified name chain of the parent symbol (e.g. "Outer.Inner"). It is used to build the stable ID and also stored as parent_id (the parent’s full ID).

Optional fields (signature, docstring) default to None, visibility defaults to Public, and is_async defaults to false. Use the builder-style setters to override.

pub fn with_parent(self, parent_id: Option<&str>) -> Self

Set the parent symbol ID.

pub fn with_signature(self, signature: Option<String>) -> Self

Set the function/method signature.

pub fn with_visibility(self, visibility: Visibility) -> Self

Set the visibility.

pub fn with_async(self, is_async: bool) -> Self

Mark as async.

pub fn with_docstring(self, docstring: Option<String>) -> Self

Set the docstring.

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 PartialEq for Symbol

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

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 Symbol

impl StructuralPartialEq for Symbol