Struct Symbol 

pub struct Symbol {
    pub name: String,
    pub kind: SymbolKind,
    pub file: PathBuf,
    pub line: u32,
    pub signature: String,
    pub token_cost: usize,
}

A symbol extracted from source code via tree-sitter.

Examples

use std::path::PathBuf;
use argus_repomap::parser::{Symbol, SymbolKind};

let sym = Symbol {
    name: "main".into(),
    kind: SymbolKind::Function,
    file: PathBuf::from("src/main.rs"),
    line: 1,
    signature: "fn main()".into(),
    token_cost: 2,
};
assert_eq!(sym.kind, SymbolKind::Function);

Fields

name: String

Symbol name (e.g. function name, struct name).

kind: SymbolKind

What kind of symbol this is.

file: PathBuf

File path (relative to repo root).

line: u32

Line number where the symbol starts (1-indexed).

signature: String

Human-readable signature (e.g. fn process(input: &str) -> Result<Output>).

token_cost: usize

Estimated token cost for including this symbol in context.

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.