Struct Symbol 

pub struct Symbol {

    pub id: SymbolId,
    pub name: String,
    pub kind: SymbolKind,
    pub visibility: Visibility,
    pub file: SourcePath,
    pub span: Span,
    pub sig_hash: Fingerprint,
    pub body_hash: Fingerprint,
    pub parent: Option<SymbolId>,
    pub signature: Option<String>,
    pub doc: Option<String>,
    pub generics: Vec<String>,
    pub tags: Vec<String>,
    pub members: Vec<Member>,
    pub flow: Option<Flow>,
}

A named definition in the codebase.

Fields

id: SymbolId

Canonical id.

name: String

Short name.

kind: SymbolKind

Kind of definition.

visibility: Visibility

Visibility.

file: SourcePath

File the definition lives in.

span: Span

Where in the file.

sig_hash: Fingerprint

Fingerprint of the symbol’s contract (name, visibility, attributes, generics, parameters, return type; see sealmap-extract’s fingerprint module for the per-kind rules). Whitespace, comments and position never affect it.

body_hash: Fingerprint

Fingerprint of the symbol’s implementation (its body). Excludes the name, so a renamed symbol keeps it.

parent: Option<SymbolId>

Enclosing symbol (the type for a method, the module for an item).

signature: Option<String>

One-line signature, e.g. pub fn connect(&self, addr: &str) -> Result<Conn>.

doc: Option<String>

First sentence of the doc comment, if any. Kept short on purpose: it is context for an agent, not a copy of the docs.

generics: Vec<String>

Generic parameters as written (T: Clone, 'a, const N: usize).

tags: Vec<String>

Notable attributes / modifiers: derives (derive(Debug)), async, unsafe, const, test, cfg(...), trait name for trait impls, etc.

members: Vec<Member>

Fields, variants and associated items.

flow: Option<Flow>

Ordered control/call flow of the body, for callables.

Implementations

impl Symbol

pub fn new( id: SymbolId, name: impl Into<String>, kind: SymbolKind, file: SourcePath, ) -> Self

A symbol with only the required fields set; everything else empty / private, and both fingerprints unset (Fingerprint::is_unset). Language adapters fill in the rest.

impl Symbol

pub fn is_unparsable(&self) -> bool

true when this is the module symbol of a file that failed to parse (it carries PARSE_ERROR_TAG).

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Self

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

impl PartialEq for Symbol

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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