Struct ConfigBuilder 

pub struct ConfigBuilder { /* private fields */ }

A robust builder for constructing, merging, and resolving configurations.

ConfigBuilder aggregates settings from multiple discrete sources (such as structured files and environment variables), seamlessly merging them into a unified internal representation before deserializing into a strongly-typed structure.

Implementations

impl ConfigBuilder

pub fn new() -> Self

Creates a new, empty ConfigBuilder.

Examples found in repository

examples/basic_usage.rs (line 24)

fn main() {
  let ron_content = r#"
        (
            app_name: "My Awesome App",
            debug_mode: true,
        )
    "#;

  std::env::set_var("APP_DEBUG_MODE", "false");

  println!("Loading configuration...");

  let result = cirious_codex_config::ConfigBuilder::new()
    .add_source(ron_content, ConfigFormat::Ron)
    .unwrap()
    .value
    .add_env_prefix("APP_")
    .build::<AppSettings>();

  match result {
    Ok(ok_wrapper) => {
      let settings = ok_wrapper.value;
      println!("App Name: {}", settings.app_name);
      println!("Debug Mode: {}", settings.debug_mode);
    }
    Err(e) => eprintln!("Failed: {e}"),
  }
}

pub fn add_source(self, content: &str, format: ConfigFormat) -> Result<Self>

Incorporates a structured configuration source into the builder.

This method parses the provided raw string content according to the specified ConfigFormat and recursively merges the resulting data into the current configuration state.

Errors

Returns an error if the content cannot be parsed by the specified format.

Examples found in repository

examples/basic_usage.rs (line 25)

fn main() {
  let ron_content = r#"
        (
            app_name: "My Awesome App",
            debug_mode: true,
        )
    "#;

  std::env::set_var("APP_DEBUG_MODE", "false");

  println!("Loading configuration...");

  let result = cirious_codex_config::ConfigBuilder::new()
    .add_source(ron_content, ConfigFormat::Ron)
    .unwrap()
    .value
    .add_env_prefix("APP_")
    .build::<AppSettings>();

  match result {
    Ok(ok_wrapper) => {
      let settings = ok_wrapper.value;
      println!("App Name: {}", settings.app_name);
      println!("Debug Mode: {}", settings.debug_mode);
    }
    Err(e) => eprintln!("Failed: {e}"),
  }
}

pub fn add_env_prefix(self, prefix: &str) -> Self

Incorporates environment variables into the configuration state.

This method iterates through the current process’s environment variables, filtering for those that start with the provided prefix. Matching variables have their prefix stripped and are converted to lowercase to align with standard configuration property casing.

Examples found in repository

examples/basic_usage.rs (line 28)

fn main() {
  let ron_content = r#"
        (
            app_name: "My Awesome App",
            debug_mode: true,
        )
    "#;

  std::env::set_var("APP_DEBUG_MODE", "false");

  println!("Loading configuration...");

  let result = cirious_codex_config::ConfigBuilder::new()
    .add_source(ron_content, ConfigFormat::Ron)
    .unwrap()
    .value
    .add_env_prefix("APP_")
    .build::<AppSettings>();

  match result {
    Ok(ok_wrapper) => {
      let settings = ok_wrapper.value;
      println!("App Name: {}", settings.app_name);
      println!("Debug Mode: {}", settings.debug_mode);
    }
    Err(e) => eprintln!("Failed: {e}"),
  }
}

pub fn build<T: DeserializeOwned>(self) -> Result<T>

Finalizes the build process and deserializes the aggregated configuration.

This method consumes the ConfigBuilder, attempting to map the deeply merged internal JSON representation into the designated strongly-typed structure T.

Errors

Returns an error if the merged configuration cannot be mapped to the target type T.

Examples found in repository

examples/basic_usage.rs (line 29)

fn main() {
  let ron_content = r#"
        (
            app_name: "My Awesome App",
            debug_mode: true,
        )
    "#;

  std::env::set_var("APP_DEBUG_MODE", "false");

  println!("Loading configuration...");

  let result = cirious_codex_config::ConfigBuilder::new()
    .add_source(ron_content, ConfigFormat::Ron)
    .unwrap()
    .value
    .add_env_prefix("APP_")
    .build::<AppSettings>();

  match result {
    Ok(ok_wrapper) => {
      let settings = ok_wrapper.value;
      println!("App Name: {}", settings.app_name);
      println!("Debug Mode: {}", settings.debug_mode);
    }
    Err(e) => eprintln!("Failed: {e}"),
  }
}

Trait Implementations

impl Debug for ConfigBuilder

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

Formats the value using the given formatter.

impl Default for ConfigBuilder

fn default() -> ConfigBuilder

Returns the “default value” for a type.