Flox Package Database 1
CRUD Operations on Nix Package Metadata
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
flox::resolver::EnvironmentManifestBase< RawType > Class Template Reference

Description of an environment in its unlocked form. More...

#include <manifest.hh>

Inheritance diagram for flox::resolver::EnvironmentManifestBase< RawType >:
flox::resolver::ManifestBase< RawType >

Public Member Functions

 EnvironmentManifestBase (const EnvironmentManifestBase &)=default
 
 EnvironmentManifestBase (EnvironmentManifestBase &&)=default
 
 EnvironmentManifestBase (RawType raw)
 
 EnvironmentManifestBase (const std::filesystem::path &manifestPath)
 
EnvironmentManifestBaseoperator= (const EnvironmentManifestBase &)=default
 
EnvironmentManifestBaseoperator= (EnvironmentManifestBase &&)=default
 
const InstallDescriptorsgetDescriptors () const
 Get descriptors from the manifest's ‘install’ field.
 
std::vector< InstallDescriptorsgetGroupedDescriptors () const
 Returns all descriptors, grouping those with a group field, and returning those without a group field as a map with a single element.
 
- Public Member Functions inherited from flox::resolver::ManifestBase< RawType >
 ManifestBase (const ManifestBase &)=default
 
 ManifestBase (ManifestBase &&) noexcept=default
 
 ManifestBase (RawType raw)
 
 ManifestBase (const std::filesystem::path &manifestPath)
 
ManifestBaseoperator= (const ManifestBase &)=default
 
ManifestBaseoperator= (ManifestBase &&) noexcept=default
 
const RawType & getManifestRaw () const
 
const RegistryRawgetRegistryRaw () const
 
RegistryRaw getLockedRegistry (const nix::ref< nix::Store > &store=NixStoreMixin().getStore()) const
 
std::vector< SystemgetSystems () const
 Get the list of systems requested by the manifest.
 
pkgdb::PkgQueryArgs getBaseQueryArgs () const
 

Private Member Functions

void check () const
 Assert the validity of the manifest, throwing an exception if it contains invalid fields.
 
void initDescriptors ()
 Initialize descriptors from manifestRaw.
 

Private Attributes

InstallDescriptors descriptors
 

Additional Inherited Members

- Public Types inherited from flox::resolver::ManifestBase< RawType >
using rawType = RawType
 
- Protected Member Functions inherited from flox::resolver::ManifestBase< RawType >
template<manifest_raw_type _RawType = RawType>
std::enable_if< std::derived_from< _RawType, GlobalManifestRaw >, void >::type initRegistry ()
 Initialize registryRaw from manifestRaw.
 
template<manifest_raw_type _RawType = RawType>
std::enable_if< std::derived_from< _RawType, GlobalManifestRawGA >, void >::type initRegistry ()
 Initialize registryRaw from manifestRaw.
 
- Protected Attributes inherited from flox::resolver::ManifestBase< RawType >
RawType manifestRaw
 
RegistryRaw registryRaw
 

Detailed Description

template<manifest_raw_type RawType>
class flox::resolver::EnvironmentManifestBase< RawType >

Description of an environment in its unlocked form.

Member Function Documentation

◆ check()

template<manifest_raw_type RawType>
void flox::resolver::EnvironmentManifestBase< RawType >::check ( ) const
inlineprivate

Assert the validity of the manifest, throwing an exception if it contains invalid fields.

This checks that:

  • The raw manifest is valid.
  • If install.<IID>.systems is set, then options.systems is also set.
  • All install.<IID>.systems are in options.systems.

Member Data Documentation

◆ descriptors

template<manifest_raw_type RawType>
InstallDescriptors flox::resolver::EnvironmentManifestBase< RawType >::descriptors
private

A map of install ID to descriptors, being descriptions/requirements of a dependency.


The documentation for this class was generated from the following file: