Struct SymbolContext 

pub struct SymbolContext {
    pub node: NodeSummary,
    pub container: Option<String>,
    pub calls: Vec<String>,
    pub called_by: Vec<String>,
    pub authored_by: Vec<String>,
}

A code symbol related to the topic, with the slice of its graph neighbourhood that grounds authoring: what defines it, what it calls / is called by, and the authored ADRs/sections that govern it.

Fields

node: NodeSummary

The symbol node.

container: Option<String>

Key of the node that contains/defines it (its file or parent), if any.

calls: Vec<String>

Keys this symbol calls.

called_by: Vec<String>

Keys that call this symbol.

authored_by: Vec<String>

Keys of ADR/section nodes with an authored edge to this symbol.

Trait Implementations

impl Clone for SymbolContext

fn clone(&self) -> SymbolContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolContext

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

Formats the value using the given formatter.

impl PartialEq for SymbolContext

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SymbolContext

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 SymbolContext