Struct SourceCodeGraph 

pub struct SourceCodeGraph {
    pub nodes: Vec<GraphNode>,
    pub edges: Vec<GraphEdge>,
    pub metadata: HashMap<String, String>,
}

Aggregate graph describing the full software project topology.

Fields

nodes: Vec<GraphNode>

All nodes that make up the graph.

edges: Vec<GraphEdge>

All edges that connect nodes in the graph.

metadata: HashMap<String, String>

Arbitrary metadata about the entire graph snapshot.

Implementations

impl SourceCodeGraph

pub fn empty() -> Self

Creates an empty graph with no nodes or edges.

pub fn node_count(&self) -> usize

Returns the number of nodes currently tracked.

pub fn edge_count(&self) -> usize

Returns the number of edges currently tracked.

pub fn to_petgraph( &self, ) -> (StableDiGraph<GraphNode, String>, HashMap<NodeId, NodeIndex>)

Convert to petgraph StableDiGraph for visualization/analysis. Returns the graph and a mapping from NodeIndex to NodeId.

Trait Implementations

impl Clone for SourceCodeGraph

fn clone(&self) -> SourceCodeGraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceCodeGraph

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

Formats the value using the given formatter.

impl Default for SourceCodeGraph

fn default() -> SourceCodeGraph

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SourceCodeGraph

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SourceCodeGraph

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.