Struct stack_graphs::partial::PartialPaths

pub struct PartialPaths { /* private fields */ }

Manages the state of a collection of partial paths built up as part of the partial-path-finding algorithm or path-stitching algorithm.

Implementations

impl PartialPaths

pub fn find_all_partial_paths_in_file<F>(
    &mut self,
    graph: &StackGraph,
    file: Handle<File>,
    cancellation_flag: &dyn CancellationFlag,
    visit: F
) -> Result<(), CancellationError>where
    F: FnMut(&StackGraph, &mut PartialPaths, PartialPath),

Finds all partial paths in a file, calling the visit closure for each one.

This function ensures that the set of visited partial paths covers all complete paths, from references to definitions, when used for path stitching. Callers are advised not to filter this set in the visitor using functions like PartialPath::is_complete_as_possible or PartialPath::is_productive as that may interfere with implementation changes of this function.

This function will not return until all reachable partial paths have been processed, so graph must already contain a complete stack graph. If you have a very large stack graph stored in some other storage system, and want more control over lazily loading only the necessary pieces, then you should code up your own loop that calls PartialPath::extend manually.

impl PartialPaths

pub fn new() -> PartialPaths