Struct Environment

pub struct Environment { /* private fields */ }

Implementations

impl Environment

pub fn new() -> Self

👎Deprecated since 0.12.0: please use ‘Environment::default’ instead

pub fn with_prefix(s: &str) -> Self

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

pub fn prefix_separator(self, s: &str) -> Self

pub fn separator(self, s: &str) -> Self

pub fn list_separator(self, s: &str) -> Self

When set and try_parsing is true, then all environment variables will be parsed as Vec<String> instead of String. See [with_list_parse_key] when you want to use Vec<String> in combination with String.

pub fn with_list_parse_key(self, key: &str) -> Self

Add a key which should be parsed as a list when collecting Values from the environment. Once list_separator is set, the type for string is Vec<String>. To switch the default type back to type Strings you need to provide the keys which should be Vec<String> using this function.

pub fn ignore_empty(self, ignore: bool) -> Self

pub fn try_parsing(self, try_parsing: bool) -> Self

Note: enabling try_parsing can reduce performance it will try and parse each environment variable 3 times (bool, i64, f64)

pub fn keep_prefix(self, keep: bool) -> Self

pub fn source(self, source: Option<Map<String, String>>) -> Self

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 Debug for Environment

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

Formats the value using the given formatter.

impl Default for Environment

fn default() -> Environment

Returns the “default value” for a type.

impl Source for Environment

fn clone_into_box(&self) -> Box<dyn Source + Send + Sync>

fn collect(&self) -> Result<Map<String, Value>, ConfigError>

Collect all configuration properties available from this source and return a Map.

fn collect_to(&self, cache: &mut Value) -> Result<(), ConfigError>

Collects all configuration properties to a provided cache.