Function brane_tsk::local::get_package_index

source · 
pub fn get_package_index(
    packages: impl AsRef<Path>,
) -> Result<PackageIndex, Error>
Expand description

Returns the an index of locally available packages and their versions.

§Arguments

  • packages_path: The path to the directory that we read the packages from.

§Returns

A PackageIndex if we could retrieve it, or a PackageError if we failed.

§Errors

This function may error if we failed to read the local packages folder or if the packages folder was incorrectly laid out.