Flox Package Database 1
CRUD Operations on Nix Package Metadata
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
flox::resolver::ManifestRawGA Struct Reference

A raw description of an environment to be read from a file. This form drops the registry field for use with flox's GA release. More...

#include <manifest-raw.hh>

Inheritance diagram for flox::resolver::ManifestRawGA:
flox::resolver::GlobalManifestRawGA

Public Member Functions

 ManifestRawGA (const ManifestRawGA &)=default
 
 ManifestRawGA (ManifestRawGA &&)=default
 
 ManifestRawGA (const GlobalManifestRawGA &globalManifestRawGA)
 
 ManifestRawGA (GlobalManifestRawGA &&globalManifestRawGA)
 
ManifestRawGAoperator= (const ManifestRawGA &)=default
 
ManifestRawGAoperator= (ManifestRawGA &&)=default
 
ManifestRawGAoperator= (const GlobalManifestRawGA &globalManifestRawGA)
 
ManifestRawGAoperator= (GlobalManifestRawGA &&globalManifestRawGA)
 
void check () const override
 Validate manifest fields, throwing an exception if its contents are invalid.
 
void clear () override
 
nlohmann::json diff (const ManifestRawGA &old) const
 Generate a JSON diff between this manifest an old manifest.
 
 operator ManifestRaw () const
 
- Public Member Functions inherited from flox::resolver::GlobalManifestRawGA
 GlobalManifestRawGA (const GlobalManifestRawGA &)=default
 
 GlobalManifestRawGA (GlobalManifestRawGA &&)=default
 
 GlobalManifestRawGA (std::optional< Options > options)
 
GlobalManifestRawGAoperator= (const GlobalManifestRawGA &)=default
 
GlobalManifestRawGAoperator= (GlobalManifestRawGA &&)=default
 
virtual void check () const
 Validate manifest fields, throwing an exception if its contents are invalid.
 
virtual void clear ()
 
 operator GlobalManifestRaw () const
 
 operator ManifestRaw () const
 

Public Attributes

std::optional< std::unordered_map< InstallID, std::optional< ManifestDescriptorRaw > > > install
 
std::optional< std::unordered_map< std::string, std::string > > vars
 
std::optional< HookRawhook
 
- Public Attributes inherited from flox::resolver::GlobalManifestRawGA
std::optional< Optionsoptions
 Options controlling environment and search behaviors.
 

Detailed Description

A raw description of an environment to be read from a file. This form drops the registry field for use with flox's GA release.

This raw struct is defined to generate parsers, and its declarations simply represent what is considered valid. On its own, it performs no real work, other than to validate the input.

See also
flox::resolver::ManifestGA

Member Function Documentation

◆ check()

void flox::resolver::ManifestRawGA::check ( ) const
overridevirtual

Validate manifest fields, throwing an exception if its contents are invalid.

This asserts:

  • All members of install are valid.
  • hook is valid.

Reimplemented from flox::resolver::GlobalManifestRawGA.

◆ clear()

void flox::resolver::ManifestRawGA::clear ( )
inlineoverridevirtual

◆ diff()

nlohmann::json flox::resolver::ManifestRawGA::diff ( const ManifestRawGA old) const

Generate a JSON diff between this manifest an old manifest.

The diff is represented as an JSON patch object.


The documentation for this struct was generated from the following files: