Struct Scan 

pub struct Scan { /* private fields */ }

Package dependency scanner.

Discovers all dependencies for a set of packages and resolves them into a buildable set with proper ordering.

Usage

1. Create a Scan with Scan::new
2. Add packages to scan with Scan::add
3. Run the scan with Scan::start
4. Resolve dependencies with Scan::resolve

Example

let config = Config::load(None, false)?;
let mut scan = Scan::new(&config);

scan.add(&PkgPath::new("mail/mutt")?);
let ctx = RunContext::new(Arc::new(AtomicBool::new(false)));
scan.start(&ctx)?;

let result = scan.resolve()?;
println!("Found {} buildable packages", result.buildable.len());

Implementations

impl Scan

pub fn new(config: &Config) -> Scan

pub fn add(&mut self, pkgpath: &PkgPath)

pub fn load_cached( &mut self, cached: IndexMap<PkgPath, Vec<ScanIndex>>, ) -> usize

Load previously cached scan results.

For limited scans, only loads cached packages reachable from the configured pkgpaths initially, but keeps the full cache available for on-demand loading when new dependencies are discovered.

Returns the number of cached packages initially loaded.

pub fn completed(&self) -> &IndexMap<PkgPath, Vec<ScanIndex>>

Access completed scan results.

pub fn start(&mut self, ctx: &RunContext) -> Result<bool>

pub fn scan_errors(&self) -> impl Iterator<Item = &str>

Returns scan failures as formatted error strings.

pub fn scan_failures(&self) -> &[(PkgPath, String)]

Returns scan failures with pkgpath information.

pub fn scan_pkgpath(&self, pkgpath: &PkgPath) -> Result<Vec<ScanIndex>>

Scan a single PKGPATH, returning a Vec of ScanIndex results, as multi-version packages may return multiple results.

pub fn scanned(&self) -> impl Iterator<Item = &ScanIndex>

Get all scanned packages (before resolution).

pub fn resolve(&mut self) -> Result<ScanResult>

Resolve the list of scanned packages, by ensuring all of the Depend patterns in all_depends match a found package, and that there are no circular dependencies. The best match for each is stored in the depends for the package in question.

Return a ScanResult containing buildable packages and skipped packages.

Note: This method consumes the internal scan state. Calling it multiple times will return empty results on subsequent calls.

Trait Implementations

impl Debug for Scan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Scan

fn default() -> Scan

Returns the “default value” for a type.