Skip to main content

analyze

Function analyze 

Source
pub fn analyze<'a, P: AsRef<Path>>(
    path: &'a P,
    options: &'a ScanOptions,
) -> impl Iterator<Item = ProjectAnalysis> + use<'a, P>
Expand description

Scan path for projects and compute each one’s reclaimable size and last modification time — a streaming convenience over scan + [project_size_and_mtime].

Each project is yielded as soon as it is found and analyzed in a single merged tree walk (size + mtime together, rather than the older separate Project::size + Project::last_modified calls). Projects that error or have zero reclaimable bytes are omitted, matching the kondo CLI’s behavior. For error-aware use, drive scan directly.