Struct PkgRegistry

pub struct PkgRegistry {
    pub repos: Vec<PkgRepo>,
    /* private fields */
}

An object used to store and cache all of the packages that we are working with. It queries repositories automatically when asking for a package that isn’t in the registry, and prevents having a bunch of copies of packages everywhere.

Fields

repos: Vec<PkgRepo>

The package repositories that the user has configured

Implementations

impl PkgRegistry

pub fn new(repos: Vec<PkgRepo>, caching_strategy: CachingStrategy) -> Self

Create a new PkgRegistry with repositories and a caching strategy

pub fn clear(&mut self)

Clear the registry

pub fn has_now(&self, req: &PkgRequest) -> bool

Checks if a package is in the registry already

pub async fn ensure_package( &mut self, req: &ArcPkgReq, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<()>

Ensure that a package is in the registry

pub async fn get_metadata<'a>( &'a mut self, req: &ArcPkgReq, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<&'a PackageMetadata>

Get the metadata of a package

pub async fn get_properties<'a>( &'a mut self, req: &ArcPkgReq, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<&'a PackageProperties>

Get the properties of a package

pub async fn get_content_type<'a>( &'a mut self, req: &ArcPkgReq, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<PackageContentType>

Get the content type of a package

pub async fn load( &mut self, req: &ArcPkgReq, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<String>

Load the contents of a package

pub async fn parse_and_validate( &mut self, req: &ArcPkgReq, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<()>

Parse and validate a package

pub async fn parse<'a>( &'a mut self, req: &ArcPkgReq, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<&'a PkgContents>

Parse a package and get the contents

pub async fn eval<'a>( &mut self, req: &ArcPkgReq, paths: &'a Paths, routine: Routine, input: EvalInput<'a>, client: &Client, plugins: &'a PluginManager, o: &mut impl MCVMOutput, ) -> Result<EvalData<'a>>

Evaluate a package

pub async fn content_type<'a>( &mut self, req: &ArcPkgReq, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<PackageContentType>

Get the content type of a package

pub async fn flags<'a>( &'a mut self, req: &ArcPkgReq, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<&'a HashSet<PackageFlag>>

Get the flags of a package

pub async fn remove_cached( &mut self, req: &ArcPkgReq, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<()>

Remove a cached package

pub fn iter_requests(&self) -> impl Iterator<Item = &ArcPkgReq>

Iterator over all package requests in the registry

pub fn get_all_packages(&self) -> Vec<ArcPkgReq>

Get all of the package requests in the registry in an owned manner

pub async fn get_all_available_packages( &mut self, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<Vec<ArcPkgReq>>

Get all of the available package requests from the repos

pub async fn update_cached_packages( &mut self, paths: &Paths, client: &Client, o: &mut impl MCVMOutput, ) -> Result<()>

Update cached package scripts based on the caching strategy

pub fn get_repos(&self) -> &[PkgRepo]

Gets the repositories stored in this registry in their correct order

Trait Implementations

impl Debug for PkgRegistry

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

Formats the value using the given formatter.