Struct pubgrub::solver::OfflineDependencyProvider

pub struct OfflineDependencyProvider<P: Package, V: Version> { /* fields omitted */ }

A basic implementation of DependencyProvider.

Implementations

impl<P: Package, V: Version> OfflineDependencyProvider<P, V>

pub fn new() -> Self

Creates an empty OfflineDependencyProvider with no dependencies.

pub fn add_dependencies<I: IntoIterator<Item = (P, Range<V>)>>(
    &mut self,
    package: P,
    version: impl Into<V>,
    dependencies: I
)

Registers the dependencies of a package and version pair. Dependencies must be added with a single call to add_dependencies. All subsequent calls to add_dependencies for a given package version pair will replace the dependencies by the new ones.

The API does not allow to add dependencies one at a time to uphold an assumption that OfflineDependencyProvider.get_dependencies(p, v) provides all dependencies of a given package (p) and version (v) pair.

pub fn packages(&self) -> impl Iterator<Item = &P>

Lists packages that have bean saved.

pub fn versions(&self, package: &P) -> Option<impl Iterator<Item = &V>>

Lists versions of saved packages in sorted order. Returns None if no information is available regarding that package.

Trait Implementations

impl<P: Clone + Package, V: Clone + Version> Clone for OfflineDependencyProvider<P, V>

pub fn clone(&self) -> OfflineDependencyProvider<P, V>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P: Debug + Package, V: Debug + Version> Debug for OfflineDependencyProvider<P, V>

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

Formats the value using the given formatter.

impl<P: Default + Package, V: Default + Version> Default for OfflineDependencyProvider<P, V>

pub fn default() -> OfflineDependencyProvider<P, V>

Returns the "default value" for a type.

impl<P: Package, V: Version> DependencyProvider<P, V> for OfflineDependencyProvider<P, V>

An implementation of DependencyProvider that contains all dependency information available in memory. Packages are picked with the fewest versions contained in the constraints first. Versions are picked with the newest versions first.

pub fn choose_package_version<T: Borrow<P>, U: Borrow<Range<V>>>(
    &self,
    potential_packages: impl Iterator<Item = (T, U)>
) -> Result<(T, Option<V>), Box<dyn Error>>

Decision making is the process of choosing the next package and version that will be appended to the partial solution. Every time such a decision must be made, potential valid packages and version ranges are preselected by the resolver, and the dependency provider must choose.

pub fn get_dependencies(
    &self,
    package: &P,
    version: &V
) -> Result<Dependencies<P, V>, Box<dyn Error>>

Retrieves the package dependencies. Return Dependencies::Unknown if its dependencies are unknown.

pub fn should_cancel(&self) -> Result<(), Box<dyn Error>>

This is called fairly regularly during the resolution, if it returns an Err then resolution will be terminated. This is helpful if you want to add some form of early termination like a timeout, or you want to add some form of user feedback if things are taking a while. If not provided the resolver will run as long as needed.