Struct Config

pub struct Config { /* private fields */ }

The configuration object for Freedom.

Used when creating a Freedom API client

Implementations

impl Config

pub const ATLAS_ENV_VAR: &'static str = "ATLAS_ENV"

The environment variable name for the atlas environment

pub const ATLAS_KEY_VAR: &'static str = "ATLAS_KEY"

The environment variable name for the atlas key

pub const ATLAS_SECRET_VAR: &'static str = "ATLAS_SECRET"

The environment variable name for the atlas secret

pub fn builder() -> ConfigBuilder

Construct a new config builder

Example

let config_result = Config::builder()
    .environment(Test)
    .key("my_key")
    .secret("my_secret")
    .build();

assert!(config_result.is_ok());

pub fn from_env() -> Result<Config, Error>

Build the entire configuration from environment variables

pub fn new( environment: impl Env, key: impl Into<String>, secret: impl Into<String>, ) -> Config

Construct the Config from the environment, key, and secret

Example

let config = Config::new(Test, "my_key", "my_secret");

pub fn set_environment(&mut self, environment: impl Env)

Set the environment

Example

config.set_environment(Prod);
assert_eq!(config.environment_str(), "prod");

pub fn environment(&self) -> &Environment

Return the trait object representing an ATLAS environment

pub fn environment_str(&self) -> &str

Return the string representation of the environment

pub fn expose_secret(&self) -> &str

Exposes the secret as a string slice.

Warning

Use this with extreme care to avoid accidentally leaking your key

pub fn key(&self) -> &str

Return the ATLAS key

pub fn set_key(&mut self, key: impl Into<String>)

Set the ATLAS key

Example

config.set_key("top secret");
assert_eq!(config.key(), "top secret");

pub fn set_secret(&mut self, secret: impl Into<String>)

Set the value of the ATLAS secret

Example

config.set_secret("top secret");
assert_eq!(config.expose_secret(), "top secret");

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.