Struct EnvConfigValue

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

Environment config values are config values sourced from a user’s environment variables or profile file.

EnvConfigValue will first look in the environment, then the AWS profile. They track the provenance of properties so that unified validation errors can be created.

Implementations

impl<'a> EnvConfigValue<'a>

pub fn new() -> Self

Create a new EnvConfigValue

pub fn env(self, key: &'a str) -> Self

Set the environment variable to read

pub fn profile(self, key: &'a str) -> Self

Set the profile key to read

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

Set the service id to check for service config

pub fn validate<T, E: Error + Send + Sync + 'static>( self, env: &Env, profiles: Option<&EnvConfigSections>, validator: impl Fn(&str) -> Result<T, E>, ) -> Result<Option<T>, EnvConfigError<E>>

Load the value from the env or profile files, validating with validator

pub fn validate_and_return_origin<T, E: Error + Send + Sync + 'static>( self, env: &Env, profiles: Option<&EnvConfigSections>, validator: impl Fn(&str) -> Result<T, E>, ) -> Result<(Option<T>, Origin), EnvConfigError<E>>

Load the value from the env or profile files, validating with validator

This version of the function will also return the origin of the config.

pub fn load( &self, env: &'a Env, profiles: Option<&'a EnvConfigSections>, ) -> Option<(Cow<'a, str>, EnvConfigSource<'a>)>

Load the value from the environment

Trait Implementations

impl<'a> Debug for EnvConfigValue<'a>

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

Formats the value using the given formatter.

impl<'a> Default for EnvConfigValue<'a>

fn default() -> EnvConfigValue<'a>

Returns the “default value” for a type.