Struct Environment

pub struct Environment { /* private fields */ }

Configuration sourced from environment variables.

Implementations

impl Environment

pub fn prefixed(prefix: &str) -> Self

Loads environment variables with the specified prefix.

pub fn from_iter<K, V>( prefix: &str, env: impl IntoIterator<Item = (K, V)>, ) -> Self

where K: AsRef<str> + Into<String>, V: Into<String>,

Creates a custom environment.

pub fn with_vars(self, var_names: &[&str]) -> Self

Adds additional variables to this environment. This is useful if the added vars don’t have the necessary prefix.

pub fn iter(&self) -> impl ExactSizeIterator<Item = (&str, &WithOrigin)> + '_

Iterates over variables in this container.

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

Strips a prefix from all contained vars and returns the filtered vars.

pub fn coerce_json(&mut self) -> Result<()>

Coerces JSON values in env variables which names end with the __json / :json suffixes and strips this suffix.

Errors

Returns an error if any coercion fails; provides a list of all failed coercions. Successful coercions are still applied in this case.

pub fn convert_flat_params( flat_params: &Map<String, Value>, prefix: &str, ) -> Map<String, Value>

Converts a flat configuration object into a flat object usable as the env var specification for Docker Compose etc. It uppercases and prefixes param names, replacing .s with _s, and replaces object / JSON params with strings so that they can be parsed via JSON coercion.

Important

Beware that additional transforms may be required depending on the use case. E.g., Docker Compose requires to escape Boolean values and nulls to strings.

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConfigSource for Environment

type Kind = Flat

Kind of the source.

fn into_contents(self) -> WithOrigin<Map>

Converts this source into config contents.

impl Debug for Environment

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

Formats the value using the given formatter.

impl Default for Environment

fn default() -> Self

Returns the “default value” for a type.