Struct ModuleGraph 

pub struct ModuleGraph {
    pub crate_name: String,
    /* private fields */
}

The complete dependency graph for a crate

Fields

crate_name: String

Name of the crate

Implementations

impl ModuleGraph

pub fn new(crate_name: String) -> Self

Create a new empty graph for the given crate

pub fn add_module(&mut self, module: Module)

Add a module to the graph

pub fn add_edge(&mut self, from: ModulePath, to: ModulePath, kind: EdgeKind)

Add an edge between two modules (no self-edges allowed)

If an edge already exists between the same modules, ModDeclaration takes precedence over UseImport.

pub fn modules(&self) -> impl Iterator<Item = &Module>

Iterate over all modules

pub fn edges( &self, ) -> impl Iterator<Item = (&ModulePath, &ModulePath, EdgeKind)>

Iterate over all edges as (from, to, kind) tuples

pub fn exclude_tests_modules(&mut self)

Remove all tests modules and their associated edges from the graph

This removes any module whose path is “tests” or ends with ::tests, along with any edges to or from those modules.

impl ModuleGraph

pub fn to_mermaid(&self) -> String

Convert the graph to Mermaid flowchart syntax

Trait Implementations

impl Debug for ModuleGraph

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

Formats the value using the given formatter.