Struct DependencyResolver

pub struct DependencyResolver<'a> { /* private fields */ }

Used to resolve dependencies for a WIT package.

Implementations

impl<'a> DependencyResolver<'a>

pub fn new( config: Option<Config>, lock_file: Option<&'a LockFile>, cache: FileCache, ) -> Result<Self>

Creates a new dependency resolver. If config is None, then the resolver will be set to offline mode and a lock file must be given as well. Anything that will require network access will fail in offline mode.

pub fn new_with_client( client: CachingClient<FileCache>, lock_file: Option<&'a LockFile>, ) -> Result<Self>

Creates a new dependency resolver with the given client. This is useful when you already have a client available. If the client is set to offline mode, then a lock file must be given or this will error

pub async fn add_dependency( &mut self, name: &PackageRef, dependency: &Dependency, ) -> Result<()>

Add a dependency to the resolver. If the dependency already exists, then it will be ignored. To override an existing dependency, use override_dependency.

pub async fn override_dependency( &mut self, name: &PackageRef, dependency: &Dependency, ) -> Result<()>

Add a dependency to the resolver. If the dependency already exists, then it will be overridden.

pub async fn add_packages( &mut self, packages: impl IntoIterator<Item = (PackageRef, VersionReq)>, ) -> Result<()>

A helper function for adding an iterator of package refs and their associated version requirements to the resolver

pub async fn resolve(self) -> Result<DependencyResolutionMap>

Resolve all dependencies.

This will download all dependencies that are not already present in client storage.

Returns the dependency resolution map.