Function load_config 

pub fn load_config<S>(path: impl AsRef<Path>) -> ConfigResult<S>
where
    S: ConfigSchema + JsonSchema,

Loads a complete confique schema from a root config path.

The loader follows recursive include paths exposed by ConfigSchema, resolves relative include paths from the declaring file, detects include cycles, loads the first .env file found from the root config directory upward, builds a Figment from config files and schema-declared environment variables, and then asks confique to apply defaults and validation. Existing process environment variables take precedence over values loaded from .env.

Type Parameters

• S: Config schema type that derives Config and implements ConfigSchema.

Arguments

• path: Root config file path.

Returns

Returns the merged config schema after loading the root file, recursive includes, .env values, and environment values.

Examples

use std::fs;
use confique::Config;
use rust_config_tree::config::load_config;
use schemars::JsonSchema;

#[derive(Debug, Config, JsonSchema, rust_config_tree::ConfigSchema)]
struct AppConfig {
    #[config(default = [])]
    include: Vec<std::path::PathBuf>,
    #[config(default = "demo")]
    mode: String,
}

let path = std::env::temp_dir().join("rust-config-tree-load-config-doctest.yaml");
fs::write(&path, "mode: local\n")?;

let config = load_config::<AppConfig>(&path)?;

assert_eq!(config.mode, "local");

Examples found in repository

examples/basic_loading.rs (line 41)

fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let root_config = write_demo_config()?;
    let config = load_config::<AppConfig>(&root_config)?;

    println!("config path: {}", root_config.display());
    println!("include count: {}", config.include.len());
    println!("mode: {}", config.mode);
    println!("server bind: {}", config.server.bind);
    println!("server port: {}", config.server.port);

    Ok(())
}

examples/transparent_array_section.rs (line 75)

fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let dir = temp_example_dir("transparent-array-section")?;
    let root = dir.join("config.yaml");
    let schema = dir.join("app.schema.json");
    let children = dir.join("children.yaml");

    fs::write(&root, "include:\n  - children.yaml\nmode: demo\n")?;
    fs::write(&children, "- name: api\n")?;

    write_config_schemas::<AppConfig>(&schema)?;
    println!("schema: {}", schema.display());

    let config = load_config::<AppConfig>(&root)?;
    println!("loaded children: {}", config.children.len());
    assert_eq!(config.children.items[0].name, "api");

    println!("split file: {}", children.display());

    let _ = fs::remove_dir_all(dir);
    Ok(())
}

examples/config_commands.rs (line 68)

fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let cli = Cli::parse();
    let config_path = match &cli.config {
        Some(path) => path.clone(),
        None => write_demo_config()?,
    };

    match cli.command.unwrap_or(Command::Run) {
        Command::Run => {
            let config = load_config::<AppConfig>(&config_path)?;
            println!("config path: {}", config_path.display());
            println!("include count: {}", config.include.len());
            println!("mode: {}", config.mode);
            println!("server bind: {}", config.server.bind);
            println!("server port: {}", config.server.port);
        }
        Command::Config(command) => {
            handle_config_command::<Cli, AppConfig>(command, &config_path)?;
        }
    }

    Ok(())
}