Struct DeclarativeConfig 

pub struct DeclarativeConfig {
    pub schema_version: u32,
    pub rev: String,
    pub hash: String,
    pub selections: HashMap<String, HashMap<String, Vec<String>>>,
}

Declarative FOMOD installation configuration.

Instead of stepping through an interactive wizard, all selections are specified upfront by name. This makes FOMOD installations reproducible and compatible with declarative systems like NixOS.

Uses the nixpkgs rev + hash pattern: rev is a human-readable version identifier and hash is an SRI hash of the installer XML for integrity verification.

Structure

{
  schema_version = 1;
  rev = "1.2.0";
  hash = "sha256-xbenkdP6HEXuWl9K...";
  selections = {
    "Choose Version" = {
      "Platform" = [ "SSE" ];
    };
  };
}

Fields

schema_version: u32

Schema version of this config format. See SCHEMA_VERSION.

rev: String

Human-readable revision of the FOMOD installer (e.g. mod version).

Sourced from info.xml when available, otherwise the module name.

hash: String

SRI hash of the source FOMOD XML (sha256-<base64>).

Follows the nixpkgs convention. Used to detect when the upstream installer has changed and this config may need to be regenerated.

selections: HashMap<String, HashMap<String, Vec<String>>>

Step name → group name → list of selected plugin names.

Implementations

impl DeclarativeConfig

pub fn from_defaults( xml: &str, rev: impl Into<String>, config: &ModuleConfig, ) -> Self

Create a template config from a FOMOD module with default selections.

• xml: raw XML source used to compute the SRI hash
• rev: human-readable version identifier (e.g. from info.xml)
• config: parsed FOMOD module configuration

pub fn from_all( xml: &str, rev: impl Into<String>, config: &ModuleConfig, ) -> Self

Create a template config with all available options listed.

Every plugin in every group is included, making it easy to see what’s available and remove what you don’t want.

pub fn apply( &self, xml: &str, installer: &mut Installer, ) -> Result<(), DeclarativeError>

Apply this declarative config to an installer, resolving names to indices.

xml is the raw FOMOD XML source, used to verify the installer hash.

Steps not present in selections use default selections. Groups not present in a step’s map also use defaults. This allows partial configs where you only override what you care about.

pub fn summary(&self) -> Vec<SelectionSummary>

Generate a human-readable summary of all selections.

pub fn diff(&self, other: &DeclarativeConfig) -> Vec<SelectionDiff>

Compute the differences between this config and another.

Trait Implementations

impl Clone for DeclarativeConfig

fn clone(&self) -> DeclarativeConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeclarativeConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeclarativeConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DeclarativeConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.