flox::resolver::ManifestRaw Struct Reference

A raw description of an environment to be read from a file. More...

#include <manifest-raw.hh>

Inheritance diagram for flox::resolver::ManifestRaw:

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

Public Attributes
std::optional< EnvBaseRaw >	envBase
std::optional< std::unordered_map< InstallID, std::optional< ManifestDescriptorRaw > > >	install
std::optional< std::unordered_map< std::string, std::string > >	vars
std::optional< HookRaw >	hook
Public Attributes inherited from flox::resolver::GlobalManifestRaw
std::optional< RegistryRaw >	registry
std::optional< Options >	options
	Options controlling environment and search behaviors.

Detailed Description

A raw description of an environment to be read from a file.

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::Manifest

Member Function Documentation

check()

void flox::resolver::ManifestRaw::check ( ) const

overridevirtual

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

This asserts:

• envBase is valid.
• registry does not contain indirect flake references.
• All members of install are valid.
• hook is valid.

Reimplemented from flox::resolver::GlobalManifestRaw.

clear()

void flox::resolver::ManifestRaw::clear ( )

inlineoverridevirtual

Reimplemented from flox::resolver::GlobalManifestRaw.

diff()

nlohmann::json flox::resolver::ManifestRaw::diff

(

const ManifestRaw &

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:

• include/flox/resolver/manifest-raw.hh
• src/resolver/manifest-raw.cc