Struct confik::EnvSource

pub struct EnvSource<'a> { /* private fields */ }

Available on crate feature env only.

A Source referring to environment variables.

Uses the envious crate for interpreting env vars.

Examples

use confik::{ConfigBuilder, Configuration, EnvSource};

#[derive(Configuration)]
struct Config {
    port: u16,
}

std::env::set_var("PORT", "1234");

let config = ConfigBuilder::<Config>::default()
    .override_with(EnvSource::new())
    .try_build()
    .unwrap();

assert_eq!(config.port, 1234);

Implementations

impl<'a> EnvSource<'a>

pub fn new() -> Self

Creates a new Source referring to environment variables.

pub fn with_prefix(self, prefix: &'a str) -> Self

Sets the envious prefix.

See envious::Config::with_prefix().

pub fn with_separator(self, separator: &'a str) -> Self

Sets the envious separator.

See envious::Config::with_separator().

pub fn with_config(self, config: Config<'a>) -> Self

Sets the envious config.

pub fn allow_secrets(self) -> Self

Allows this source to contain secrets.

Trait Implementations

impl<'a> Clone for EnvSource<'a>

fn clone(&self) -> EnvSource<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EnvSource<'a>

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

Formats the value using the given formatter.

impl<'a> Default for EnvSource<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Source for EnvSource<'a>

fn allows_secrets(&self) -> bool

Whether this source is allowed to contain secret data.

fn provide<T: ConfigurationBuilder>( &self ) -> Result<T, Box<dyn Error + Sync + Send>>

Attempts to provide a partial configuration object from this source.