Struct zcfg::Config
[−]
[src]
pub struct Config<T: Clone> { /* fields omitted */ }
A configurable element in the associated module
Methods
impl<T: Clone> Config<T>[src]
fn __new_cfg_in_macro_do_not_use_elsewhere(
name: String,
file_name: String,
line_number: u32,
description: &'static str,
default_value: T,
get_value: fn() -> T,
set_for_testing: fn(_: T)
) -> Config<T>[src]
name: String,
file_name: String,
line_number: u32,
description: &'static str,
default_value: T,
get_value: fn() -> T,
set_for_testing: fn(_: T)
) -> Config<T>
Constructs a new config object for the known static initializer retrieval methods.
This is public by necessity for access by the declare_cfg macros.
fn name(&self) -> &str[src]
fn file_name(&self) -> &str[src]
fn line_number(&self) -> u32[src]
fn description(&self) -> &str[src]
fn get_value(&self) -> T[src]
Fetch the current value for this config from global state.
It may or may not be initialized.
To increase testability you should limit retrieval of config values to some dependency resolution area of your code, rather than within business logic.
fn set_for_testing(&self, v: T)[src]
Sets the value of this config directly for testing.
Concurrent tests that invoke this method will probably be flakey. Prefer to set this in a std::sync::ONCE block, and verify that it has been called.
fn reset_for_testing(&self)[src]
Resets the value of this config back to its default directly for testing.
Concurrent tests that invoke this method will probably be flakey. Prefer to set this in a std::sync::ONCE block, and verify that it has been called.