Struct FeatGraph

pub struct FeatGraph<'a> {
    pub root: NodeIndex,
    pub workspace_members: BTreeSet<Pid<'a>>,
    pub features: Graph<Feature<'a>, Link>,
    pub fid_cache: BTreeMap<Fid<'a>, NodeIndex>,
    pub platforms: Vec<&'a str>,
    pub cfgs: Vec<Cfg>,
    pub triggers: Vec<Trigger<'a>>,
    pub focus_nodes: Option<BTreeSet<NodeIndex>>,
    pub focus_edges: Option<BTreeSet<EdgeIndex>>,
    pub focus_targets: Option<BTreeSet<NodeIndex>>,
    /* private fields */
}

Fields

root: NodeIndex

root node, should be 0

workspace_members: BTreeSet<Pid<'a>>

set of workspace members

features: Graph<Feature<'a>, Link>

a dependency graph between features Feature = Fid + decoration if it’s external, internal or root

fid_cache: BTreeMap<Fid<'a>, NodeIndex>

platforms: Vec<&'a str>

cfgs: Vec<Cfg>

triggers: Vec<Trigger<'a>>

focus_nodes: Option<BTreeSet<NodeIndex>>

focus_edges: Option<BTreeSet<EdgeIndex>>

focus_targets: Option<BTreeSet<NodeIndex>>

Implementations

impl<'a> FeatGraph<'a>

pub fn fid_index(&mut self, fid: Fid<'a>) -> NodeIndex

pub fn base_node(&self, node: NodeIndex) -> Option<NodeIndex>

for any node find node for the base of this package

pub fn shrink_to_target(&mut self) -> Result<()>

pub fn init( meta: &'a Metadata, platforms: Vec<&'a str>, cfgs: Vec<Cfg>, ) -> Result<Self>

pub fn optimize(&mut self, no_transitive: bool) -> Result<()>

pub fn rebuild_cache(&mut self) -> Result<()>

pub fn add_edge<A, B>( &mut self, a: A, b: B, optional: bool, kind: DepKindInfo, ) -> Result<NodeIndex>

where A: HasIndex<'a>, B: HasIndex<'a>,

Trait Implementations

impl<'a> GraphWalk<'a, NodeIndex, EdgeIndex> for FeatGraph<'a>

fn nodes(&'a self) -> Nodes<'a, NodeIndex>

Returns all the nodes in this graph.

fn edges(&'a self) -> Edges<'a, EdgeIndex>

Returns all of the edges in this graph.

fn source(&'a self, edge: &EdgeIndex) -> NodeIndex

The source node for edge.

fn target(&'a self, edge: &EdgeIndex) -> NodeIndex

The target node for edge.

impl<'a> Index<NodeIndex> for FeatGraph<'a>

type Output = Fid<'a>

The returned type after indexing.

fn index(&self, index: NodeIndex) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> Index<Pid<'a>> for FeatGraph<'a>

type Output = NodeIndex

The returned type after indexing.

fn index(&self, index: Pid<'a>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> Labeller<'a, NodeIndex, EdgeIndex> for FeatGraph<'a>

fn graph_id(&'a self) -> Id<'a>

Must return a DOT compatible identifier naming the graph.

fn node_id(&'a self, n: &NodeIndex) -> Id<'a>

Maps n to a unique identifier with respect to self. The implementer is responsible for ensuring that the returned name is a valid DOT identifier.

fn node_shape(&'a self, node: &NodeIndex) -> Option<LabelText<'a>>

Maps n to one of the graphviz shape names. If None is returned, no shape attribute is specified.

fn node_label(&'a self, n: &NodeIndex) -> LabelText<'a>

Maps n to a label that will be used in the rendered output. The label need not be unique, and may be the empty string; the default is just the output from node_id.

fn edge_label(&'a self, e: &EdgeIndex) -> LabelText<'a>

Maps e to a label that will be used in the rendered output. The label need not be unique, and may be the empty string; the default is in fact the empty string.

fn node_style(&'a self, n: &NodeIndex) -> Style

Maps n to a style that will be used in the rendered output.

fn node_color(&'a self, node: &NodeIndex) -> Option<LabelText<'a>>

Maps n to one of the graphviz color names. If None is returned, no color attribute is specified.

fn edge_end_arrow(&'a self, _e: &EdgeIndex) -> Arrow

Maps e to arrow style that will be used on the end of an edge. Defaults to default arrow style.

fn edge_start_arrow(&'a self, _e: &EdgeIndex) -> Arrow

Maps e to arrow style that will be used on the end of an edge. Defaults to default arrow style.

fn edge_style(&'a self, e: &EdgeIndex) -> Style

Maps e to a style that will be used in the rendered output.

fn edge_color(&'a self, e: &EdgeIndex) -> Option<LabelText<'a>>

Maps e to one of the graphviz color names. If None is returned, no color attribute is specified.

fn kind(&self) -> Kind

The kind of graph, defaults to Kind::Digraph.