Struct ConfiqueEnvProvider 

pub struct ConfiqueEnvProvider { /* private fields */ }

Figment provider that maps environment variables declared in confique schema metadata onto their exact field paths.

This provider reads #[config(env = "...")] from Config::META and avoids Figment’s delimiter-based environment key splitting. Environment variables such as APP_DATABASE_POOL_SIZE can therefore map to a Rust field named database.pool_size without treating the single underscores as nested separators.

Implementations

impl ConfiqueEnvProvider

Constructors for environment providers derived from confique metadata.

pub fn new<S>() -> Self

where S: Config,

Creates an environment provider for a confique schema.

Type Parameters

• S: Config schema whose metadata declares environment variable names.

Arguments

This function has no arguments.

Returns

Returns a provider that emits only environment variables declared by S.

Examples

use confique::Config;
use rust_config_tree::ConfiqueEnvProvider;

#[derive(Config)]
struct AppConfig {
    #[config(env = "APP_MODE", default = "demo")]
    mode: String,
}

let provider = ConfiqueEnvProvider::new::<AppConfig>();

Trait Implementations

impl Clone for ConfiqueEnvProvider

fn clone(&self) -> ConfiqueEnvProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Provider for ConfiqueEnvProvider

Supplies Figment data and source labels for schema-declared environment variables.

fn metadata(&self) -> Metadata

Builds metadata used by Figment source tracing.

Arguments

• self: Environment provider whose path-to-variable mapping should be exposed in metadata.

Returns

Returns Figment metadata that renders schema paths as native env names.

Examples

let _ = ();

fn data(&self) -> Result<Map<Profile, Dict>, Error>

Reads configured environment variables into Figment data.

Arguments

• self: Environment provider wrapping the filtered Figment env source.

Returns

Returns Figment data grouped by profile, or a Figment error.

Examples

let _ = ();

fn profile(&self) -> Option<Profile>

Optionally returns a profile to set on the Figment this provider is merged into. The profile is only set if self is merged.