Skip to main content

RootConfig

Trait RootConfig 

Source
pub trait RootConfig: Configurable<Partial: PartialTree<Resolved = Self>> {
    // Required method
    fn use_system_config(partial: &Self::Partial) -> SystemConfigSetting;

    // Provided method
    fn load(path: impl AsRef<Path>) -> Result<Self, ConfigError>
       where Self: Sized { ... }
}
Expand description

A configuration that a document can be loaded into.

Only the root of a configuration carries the setting that decides which system configuration to layer underneath it.

Required Methods§

Source

fn use_system_config(partial: &Self::Partial) -> SystemConfigSetting

Whether, and from where, to read a system configuration, as the document said, or None if it said nothing. Generated by the derive from the field marked #[config(use_system_config)].

Provided Methods§

Source

fn load(path: impl AsRef<Path>) -> Result<Self, ConfigError>
where Self: Sized,

Load this configuration from path

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§