Struct specifications::package::PackageIndex

pub struct PackageIndex {
    pub packages: HashMap<String, PackageInfo>,
    pub latest: HashMap<String, (Version, String)>,
}

Collects multiple PackageInfos into one database, called the package index.

Fields

packages: HashMap<String, PackageInfo>

The list of packages stored in the index.

latest: HashMap<String, (Version, String)>

Cache of the standard ‘latest’ packages so we won’t have to search every time.

Implementations

impl PackageIndex

pub fn empty() -> Self

Constructor for the PackageIndex that initializes it to having no packages.

pub fn new(packages: HashMap<String, PackageInfo>) -> Self

Constructor for the PackageIndex.

Arguments

• packages: The map of packages to base this index on. Each key should be <name>-<version> (i.e., every package version is a separate entry).

pub fn from_path(path: &Path) -> Result<Self, PackageIndexError>

Edited: Returns PackageIndexErrors now.

Tries to construct a new PackageIndex from the application file at the given path.

Arguments

• path: Path to the application file.

Returns
The new PackageIndex if it all went fine, or a PackageIndexError if it didn’t.

pub fn from_reader<R: Read>(r: R) -> Result<Self, PackageIndexError>

Edited: Returns PackageIndexErrors now.

Tries to construct a new PackageIndex from the given reader.

Arguments

• r: The reader that contains the data to construct the PackageIndex from.

Returns
The new PackageIndex if it all went fine, or a PackageIndexError if it didn’t.

pub async fn from_url(url: &str) -> Result<Self, PackageIndexError>

Edited: Returns PackageIndexErrors now.

Tries to construct a new PackageIndex from a JSON file at the given URL.

Arguments

• url: The location of the JSON file to parse.

Returns
The new PackageIndex if it all went fine, or a PackageIndexError if it didn’t.

pub fn from_value(v: JValue) -> Result<Self, PackageIndexError>

Edited: Returns PackageIndexErrors now.

Tries to construct a new PackageIndex from the given JSON-parsed value.

Arguments

• v: The JSON root value of the tree to parse.

Returns
The new PackageIndex if it all went fine, or a PackageIndexError if it didn’t.

pub fn from_packages( known_packages: Vec<PackageInfo>, ) -> Result<Self, PackageIndexError>

Edited: Returns PackageIndexErrors now.

Tries to construct a new PackageIndex from a list of PackageInfos.

Arguments

• known_packages: List of PackageInfos to incorporate in the PackageIndex.

Returns
The new PackageIndex if it all went fine, or a PackageIndexError if it didn’t.

pub fn get(&self, name: &str, version: Option<&Version>) -> Option<&PackageInfo>

Returns the package with the given name and (optional) version.

Arguments

• name: The name of the package.
• version: The version of the package to get. If omitted, uses the latest version known to the PackageIndex.

Returns
An (immuteable) reference to the package if it exists, or else None.

Trait Implementations

impl Clone for PackageIndex

fn clone(&self) -> PackageIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackageIndex

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

Formats the value using the given formatter.

impl Default for PackageIndex

fn default() -> PackageIndex

Returns the “default value” for a type.