Struct BackgroundTraversal 

pub struct BackgroundTraversal {
    pub root_idx: TreeIndex,
    pub stats: TraversalStats,
    pub event_rx: Receiver<TraversalEvent>,
    /* private fields */
}

An in-progress traversal which exposes newly obtained entries

Fields

root_idx: TreeIndex

Tree node index that acts as root for this traversal integration.

stats: TraversalStats

Running traversal statistics.

event_rx: Receiver<TraversalEvent>

Receiver used to obtain traversal events from the worker thread.

Implementations

impl BackgroundTraversal

pub fn start( root_idx: TreeIndex, walk_options: &WalkOptions, input: Vec<PathBuf>, pattern_roots: Option<&[PathBuf]>, skip_root: bool, use_root_path: bool, ) -> Result<BackgroundTraversal>

Start a background thread to perform the actual tree walk, and dispatch the results as events to be received on BackgroundTraversal::event_rx.

pub fn start_incremental( root_idx: TreeIndex, walk_options: &WalkOptions, input: Vec<PathBuf>, pattern_roots: Option<&[PathBuf]>, skip_root: bool, use_root_path: bool, preexisting_nodes: Vec<(PathBuf, TreeIndex, bool)>, ) -> Result<BackgroundTraversal>

Start an incremental traversal that preserves subtrees listed in preexisting_nodes.

This is used when extending a traversal to a parent directory: rescanning an existing subtree would waste work and duplicate its nodes and totals. Each tuple is (path, node, needs_metadata). needs_metadata is true when the node was a synthetic traversal root that represented the directory’s contents but not the directory entry itself; once that root becomes a child, its own metadata must be integrated.

pub fn root_nodes(&self) -> Option<Vec<TreeIndex>>

Return the top-level nodes in the same order as the traversal inputs once all roots exist.

pub fn integrate_traversal_event( &mut self, traversal: &mut Traversal, event: TraversalEvent, ) -> Option<bool>

Integrate event into traversal t so its information is represented by it. This builds the traversal tree from a directory-walk.

Returns

• Some(true) if the traversal is finished
• Some(false) if the caller may update its state after throttling kicked in
• None - the event was written into the traversal, but there is nothing else to do

Panics

Panics if a child entry arrives before its parent, violating the parent-first traversal invariant.