Struct ConfigDocument 

pub struct ConfigDocument {

    pub policy: Policy,
    pub preflight: PreflightDef,
    pub catalog: String,
    pub catalog_digest: String,
    pub versions: BTreeMap<String, String>,
    pub groups: BTreeMap<String, Vec<String>>,
    pub cargo_tools: BTreeMap<String, CargoToolInput>,
    pub cargo_toolsets: BTreeMap<String, BTreeMap<String, CargoToolInput>>,
    pub package_tools: BTreeMap<String, PackageToolDef>,
    pub rustup_tools: BTreeMap<String, RustupToolInput>,
    pub sources: BTreeMap<String, SourceDef>,
    pub profiles: BTreeMap<String, ProfileDef>,
    pub components: Vec<ComponentDef>,
    pub environment: EnvironmentDef,
    pub apt_mirror: Option<AptMirrorDef>,
    pub include: Vec<PathBuf>,
}

Canonical configuration document consumed by the planner.

Fields

policy: Policy

Global security, network, and resource policy.

preflight: PreflightDef

Installation prerequisites executed before package mirrors and component detection.

catalog: String

Built-in catalog identifier that supplies the base configuration.

catalog_digest: String

Digest of the expanded catalog used to bind plans to their configuration source.

versions: BTreeMap<String, String>

Named version values referenced by compact tool declarations.

groups: BTreeMap<String, Vec<String>>

Named component lists expanded by profiles and dependency references.

cargo_tools: BTreeMap<String, CargoToolInput>

Short, typed declarations expanded into canonical components at load time.

cargo_toolsets: BTreeMap<String, BTreeMap<String, CargoToolInput>>

Named Cargo tool collections expanded into components and a same-named group.

package_tools: BTreeMap<String, PackageToolDef>

Compact system-package declarations expanded into platform-specific components.

rustup_tools: BTreeMap<String, RustupToolInput>

Compact rustup declarations expanded into canonical components.

sources: BTreeMap<String, SourceDef>

Named upstream source definitions.

profiles: BTreeMap<String, ProfileDef>

Named installation profiles.

components: Vec<ComponentDef>

Canonical component definitions available to the planner.

environment: EnvironmentDef

Environment paths and mutations applied after installation.

apt_mirror: Option<AptMirrorDef>

Optional APT mirror configuration.

include: Vec<PathBuf>

Relative local configuration fragments merged after the primary file.

Implementations

impl ConfigDocument

pub fn parse(input: &str) -> Result<Self, ForgeError>

Parse and validate a user configuration that selects the supported built-in catalog.

Errors

Returns ForgeError for invalid TOML, unknown fields, an absent catalog selection, or any semantic validation failure.

pub fn validate(&self) -> Result<(), ForgeError>

Validate identifiers, references, policy limits, platform selectors, and backend contracts.

Errors

Returns ForgeError::Config for the first rejected configuration invariant.

pub fn merge_overlay_text( &mut self, input: &str, origin: &str, origins: &mut OriginMap, ) -> Result<(), ForgeError>

Merge one overlay while recording the source of every changed canonical field.

Errors

Returns ForgeError when the overlay cannot be parsed, attempts an unsupported merge, or leaves the document semantically invalid.

pub fn component(&self, id: &str) -> Option<&ComponentDef>

Find a canonical component by its stable identifier.

Trait Implementations

impl Clone for ConfigDocument

fn clone(&self) -> ConfigDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigDocument

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

Formats the value using the given formatter.

impl Default for ConfigDocument

fn default() -> ConfigDocument

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConfigDocument

where ConfigDocument: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ConfigDocument

impl JsonSchema for ConfigDocument

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ConfigDocument

fn eq(&self, other: &ConfigDocument) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ConfigDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConfigDocument