Struct SingleModuleGraph

pub struct SingleModuleGraph {
    pub number_of_modules: usize,
    pub entries: GraphEntriesT,
    /* private fields */
}

Fields

number_of_modules: usize

The number of modules in the graph (excluding VisitedModule nodes)

entries: GraphEntriesT

Implementations

impl SingleModuleGraph

pub fn cell(self) -> Vc<Self>

Places a value in a cell of the current task.

Cell is selected based on the value type and call order of cell.

pub fn resolved_cell(self) -> ResolvedVc<Self>

Places a value in a cell of the current task. Returns a ResolvedVc.

Cell is selected based on the value type and call order of cell.

impl SingleModuleGraph

pub fn iter_nodes( &self, ) -> impl Iterator<Item = &SingleModuleGraphModuleNode> + '_

Iterate over all nodes in the graph

pub fn entry_modules( &self, ) -> impl Iterator<Item = ResolvedVc<Box<dyn Module>>> + '_

Iterate over all nodes in the graph

pub fn enumerate_nodes( &self, ) -> impl Iterator<Item = (NodeIndex, &SingleModuleGraphNode)> + '_

Enumerate all nodes in the graph

pub fn traverse_from_entry<'a>( &'a self, entry: ResolvedVc<Box<dyn Module>>, visitor: impl FnMut(&'a SingleModuleGraphModuleNode), ) -> Result<()>

Traverses all reachable nodes (once)

pub fn traverse_edges_from_entries<'a>( &'a self, entries: impl IntoIterator<Item = ResolvedVc<Box<dyn Module>>>, visitor: impl FnMut(Option<(&'a SingleModuleGraphModuleNode, &'a ChunkingType)>, &'a SingleModuleGraphModuleNode) -> GraphTraversalAction, ) -> Result<()>

Traverses all reachable edges exactly once and calls the visitor with the edge source and target.

This means that target nodes can be revisited (once per incoming edge).

• entry - The entry module to start the traversal from
• visitor - Called before visiting the children of a node.
  • Receives (originating &SingleModuleGraphNode, edge &ChunkingType), target &SingleModuleGraphNode, state &S
  • Can return GraphTraversalActions to control the traversal

pub fn traverse_edges<'a>( &'a self, visitor: impl FnMut((Option<(&'a SingleModuleGraphModuleNode, &'a ChunkingType)>, &'a SingleModuleGraphModuleNode)) -> GraphTraversalAction, ) -> Result<()>

Traverses all edges exactly once and calls the visitor with the edge source and target.

This means that target nodes can be revisited (once per incoming edge).

pub fn traverse_edges_from_entries_topological<'a, S>( &'a self, entries: impl IntoIterator<Item = ResolvedVc<Box<dyn Module>>>, state: &mut S, visit_preorder: impl FnMut(Option<(&'a SingleModuleGraphModuleNode, &'a ChunkingType)>, &'a SingleModuleGraphNode, &mut S) -> Result<GraphTraversalAction>, visit_postorder: impl FnMut(Option<(&'a SingleModuleGraphModuleNode, &'a ChunkingType)>, &'a SingleModuleGraphNode, &mut S), ) -> Result<()>

Traverses all reachable edges in topological order. The preorder visitor can be used to forward state down the graph, and to skip subgraphs

Use this to collect modules in evaluation order.

Target nodes can be revisited (once per incoming edge). Edges are traversed in normal order, so should correspond to reference order.

• entry - The entry module to start the traversal from
• state - The state to be passed to the visitors
• visit_preorder - Called before visiting the children of a node.
  • Receives: (originating &SingleModuleGraphNode, edge &ChunkingType), target &SingleModuleGraphNode, state &S
  • Can return GraphTraversalActions to control the traversal
• visit_postorder - Called after visiting the children of a node. Return
  • Receives: (originating &SingleModuleGraphNode, edge &ChunkingType), target &SingleModuleGraphNode, state &S

pub fn traverse_cycles<'l>( &'l self, edge_filter: impl Fn(&'l ChunkingType) -> bool, visit_cycle: impl FnMut(&[&'l SingleModuleGraphModuleNode]), )

impl SingleModuleGraph

pub fn new_with_entries( entries: Vc<GraphEntries>, include_traced: bool, ) -> Vc<Self>

pub fn new_with_entries_visited( entries: Vc<GraphEntries>, visited_modules: Vc<VisitedModules>, include_traced: bool, ) -> Vc<Self>

pub fn new_with_entries_visited_intern( entries: GraphEntriesT, visited_modules: Vc<VisitedModules>, include_traced: bool, ) -> Vc<Self>

Trait Implementations

impl Clone for SingleModuleGraph

fn clone(&self) -> SingleModuleGraph

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SingleModuleGraph

fn default() -> SingleModuleGraph

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SingleModuleGraph

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SingleModuleGraph> for Vc<SingleModuleGraph>

fn from(value: SingleModuleGraph) -> Self

Converts to this type from the input type.

impl Serialize for SingleModuleGraph

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ShrinkToFit for SingleModuleGraph

fn shrink_to_fit(&mut self)

impl TraceRawVcs for SingleModuleGraph

fn trace_raw_vcs(&self, __context__: &mut TraceRawVcsContext)

fn get_raw_vcs(&self) -> Vec<RawVc>

impl ValueDebug for SingleModuleGraph

fn dbg(self: Vc<Self>) -> Vc<ValueDebugString>

fn dbg_depth(self: Vc<Self>, depth: usize) -> Vc<ValueDebugString>

Like dbg, but with a depth limit.

impl ValueDebugFormat for SingleModuleGraph

fn value_debug_format<'a>(&'a self, depth: usize) -> ValueDebugFormatString<'a>

impl VcValueType for SingleModuleGraph

type Read = VcDefaultRead<SingleModuleGraph>

How to read the value.

type CellMode = VcCellNewMode<SingleModuleGraph>

How to update cells of this value type.

fn get_value_type_id() -> ValueTypeId

Returns the type id of the value type.

impl NonLocalValue for SingleModuleGraph

impl Upcast<Box<dyn ValueDebug>> for SingleModuleGraph