cargo-modules 0.26.0

A cargo plugin for showing a tree-like overview of a crate's modules.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

use std::fmt;

use petgraph::stable_graph::StableGraph;

use crate::item::Item;

mod builder;
mod walker;

pub(crate) use self::{builder::GraphBuilder, walker::GraphWalker};

pub type Graph<N, E> = StableGraph<N, E>;

pub type Node = Item;
pub type Edge = Relationship;

#[derive(Copy, Clone, Hash, Eq, PartialEq, Debug)]
pub enum Relationship {
    Uses,
    Owns,
}

impl Relationship {
    pub fn display_name(&self) -> &'static str {
        match self {
            Self::Uses => "uses",
            Self::Owns => "owns",
        }
    }
}

impl fmt::Display for Relationship {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let name = match self {
            Self::Uses => "Uses",
            Self::Owns => "Owns",
        };
        write!(f, "{name}")
    }
}