Struct CodeSymbol 

pub struct CodeSymbol {
    pub path: String,
    pub language: Option<String>,
    pub name: String,
    pub kind: SymbolKind,
    pub signature: String,
    pub exported: bool,
    pub documentation: Option<String>,
    pub line_start: usize,
    pub line_end: usize,
    pub parent: Option<String>,
    pub parser: ParserKind,
    pub detail: Option<String>,
}

A code or manifest symbol indexed by ProjectAtlas.

Fields

path: String

Repository-relative file path.

language: Option<String>

Detected language or file family.

name: String

Symbol name.

kind: SymbolKind

Symbol kind.

signature: String

Compact declaration signature or source row.

exported: bool

Whether the declaration is exported or publicly visible.

documentation: Option<String>

Extracted doc comment or docstring associated with the symbol.

line_start: usize

One-based start line.

line_end: usize

One-based end line.

parent: Option<String>

Optional containing symbol name.

parser: ParserKind

Parser strategy that produced this symbol.

detail: Option<String>

Optional detail, usually the original parser node kind.

Trait Implementations

impl Clone for CodeSymbol

fn clone(&self) -> CodeSymbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeSymbol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CodeSymbol

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CodeSymbol

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

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 CodeSymbol

impl StructuralPartialEq for CodeSymbol