Struct Configuration

pub struct Configuration { /* private fields */ }

Configuration Instance, See Examples, How to Initialize Configuration for details.

Implementations

impl Configuration

pub fn new() -> Self

Create an empty Configuration.

If you want to use predefined sources, please try Configuration::with_predefined or Configuration::with_predefined_builder.

pub fn register_kv<N: Into<String>>(self, name: N) -> ManualSource

Register key value manually.

pub fn register_prefix_env(self, prefix: &str) -> Result<Self, ConfigError>

Register all env variables with prefix, default prefix is CFG.

• prefix - Env variable prefix.

If prefix is CFG, then all env variables with pattern CFG_* will be added into configuration.

Examples:

1. CFG_APP_NAME => app.name
2. CFG_APP_0_NAME => app[0].name

pub fn register_file<P: Into<PathBuf>>( self, path: P, required: bool, ) -> Result<Self, ConfigError>

Register file source, this method uses file extension¹ to choose how to parsing configuration.

• path - Config file path.
• required - Whether config file must exist.

See Supported File Formats for details.

---

1. cfg-rs does not enable any file format by default, please enable specific features when use this method. ↩

pub fn register_random(self) -> Result<Self, ConfigError>

Available on crate feature rand only.

Register random value source, must enable feature rand.

Supported integer types:

• random.u8
• random.u16
• random.u32
• random.u64
• random.u128
• random.usize
• random.i8
• random.i16
• random.i32
• random.i64
• random.i128
• random.isize

pub fn register_source<L: ConfigSource + 'static>( self, loader: L, ) -> Result<Self, ConfigError>

Register customized source, see How to Initialize Configuration, ConfigSource for details.

pub fn refresh_ref(&self) -> Result<bool, ConfigError>

Refresh all RefValues without change Configuration itself.

pub fn refresh(&mut self) -> Result<bool, ConfigError>

Refresh all RefValues and Configuration itself.

pub fn get<T: FromConfig>(&self, key: &str) -> Result<T, ConfigError>

Get config from configuration by key, see ConfigKey for the key’s pattern details.

• key - Config Key. Key examples:

1. cfg.v1
2. cfg.v2[0]
3. cfg.v3[0][1]
4. cfg.v4.key
5. cfg.v5.arr[0]

pub fn get_or<T: FromConfig>(&self, key: &str, def: T) -> Result<T, ConfigError>

Get config from configuration by key, otherwise return default. See ConfigKey for the key’s pattern details.

• key - Config Key.
• def - If config value is not found, then return def.

pub fn get_predefined<T: FromConfigWithPrefix>(&self) -> Result<T, ConfigError>

Get config with predefined key, which is automatically derived by FromConfig.

pub fn source_names(&self) -> Vec<&str>

Get source names, just for test.

pub fn with_predefined_builder() -> PredefinedConfigurationBuilder

Create predefined sources builder, see init for details.

pub fn with_predefined() -> Result<Self, ConfigError>

Create predefined configuration, see init for details.

Trait Implementations

impl Default for Configuration

fn default() -> Self

Returns the “default value” for a type.