Struct LocalCatalog 

pub struct LocalCatalog { /* private fields */ }

A ManagedCatalog type to mediate and aggregate the contents of one or more “upstream” catalogs

Division of responsibilities with upstream catalogs

LocalCatalog:

• Tracks which modules are installed on-disk
• Manages the on-disk location of the downloaded / cached modules
• TODO-Future: will track requirements and module dependency trees

upstream Catalogs:

• Track which modules are available from the outside world
• Track the remote location of each module and any parameters needed to access it

Implementations

impl LocalCatalog

pub fn new(caches_dir: &Path, name: &str) -> Result<Self, String>

pub fn push_upstream_catalog(&mut self, catalog: Box<dyn ModuleCatalog>)

pub fn upstream_catalogs(&self) -> &[Box<dyn ModuleCatalog>]

Trait Implementations

impl Debug for LocalCatalog

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

Formats the value using the given formatter.

impl ManagedCatalog for LocalCatalog

fn clear_all(&self) -> Result<(), String>

Clears all locally stored modules, resetting the local catalog to an empty state

fn fetch( &self, descriptor: &ModuleDescriptor, update_mode: UpdateMode, ) -> Result<(), String>

Fetch a specific module from the UpstreamCatalog. Returns `Ok(())`` if the module already exists in the catalog

fn remove(&self, descriptor: &ModuleDescriptor) -> Result<(), String>

Remove a specific module from the catalog

fn fetch_newest_for_all(&self, update_mode: UpdateMode) -> Result<(), String>

AKA “upgrade”. Fetches the newest version for each module that currently exists in the catalog

impl ModuleCatalog for LocalCatalog

fn display_name(&self) -> String

The name of the catalog, to be displayed to the user

fn lookup(&self, name: &str) -> Vec<ModuleDescriptor>

Returns the ModuleDescriptor for every module in the ModuleCatalog with the specified name

fn get_loader( &self, descriptor: &ModuleDescriptor, ) -> Result<Box<dyn ModuleLoader>, String>

Returns a ModuleLoader for the specified module from the ModuleCatalog

fn list<'a>(&'a self) -> Option<Box<dyn Iterator<Item = ModuleDescriptor> + 'a>>

Returns an iterator over every module available in the catalog. May not be supported by all catalog implementations

fn sync_toc(&self, update_mode: UpdateMode) -> Result<(), String>

Synchronize the catalog’s internal tables, so fresh upstream info is reflected locally. Does not fetch any modules

fn as_managed(&self) -> Option<&dyn ManagedCatalog>

Returns the catalog as a ManagedCatalog if the catalog supports active management

fn lookup_with_uid(&self, name: &str, uid: Option<u64>) -> Vec<ModuleDescriptor>

Returns the ModuleDescriptor for every module in the ModuleCatalog with the specified name, and uid match

fn lookup_with_version_req( &self, name: &str, version_req: Option<&VersionReq>, ) -> Vec<ModuleDescriptor>

Returns the ModuleDescriptor for every module in the ModuleCatalog with the specified name matching the version requirements

fn lookup_newest_with_version_req( &self, name: &str, version_req: Option<&VersionReq>, ) -> Option<ModuleDescriptor>

Returns the ModuleDescriptor for the newest module in the ModuleCatalog, that matches the specified version requirement, or None if no module exists

fn lookup_newest_with_uid_and_version_req( &self, name: &str, uid: Option<u64>, version_req: Option<&VersionReq>, ) -> Option<ModuleDescriptor>

Returns the ModuleDescriptor for the newest module in the ModuleCatalog, that matches the specified name, uid, and version requirement, or None if no module exists

fn list_names<'a>(&'a self) -> Option<Box<dyn Iterator<Item = String> + 'a>>

Returns an iterator over every unique module name in the catalog. May not be supported by all catalog implementations

fn list_name_uid_pairs<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = (String, Option<u64>)> + 'a>>

Returns an iterator over every unique (module name, uid) pair in the catalog. May not be supported by all catalog implementations

fn as_any(&self) -> Option<&dyn Any>

Returns the catalog as an Any in order to get back to the underlying object