Struct Config 

pub struct Config { /* private fields */ }

Configuration value storage.

Implementations

impl Config

pub fn get<'de, S, T>(&self, path: &[S]) -> Result<Option<T>, Error>

where S: AsRef<str>, T: Deserialize<'de>,

Get the current value of a config option.

This will return Ok(None) if the requested option does not exist, and an error if it does not match the requested type. This will never error if T is toml::Value.

Example

use configory::Manager;

let manager = Manager::new("configory", ()).unwrap();
manager.set(&["option"], 3);

let existing_value = manager.get::<_, i32>(&["option"]);
let missing_value = manager.get::<_, i32>(&["missing"]);

assert_eq!(existing_value, Ok(Some(3)));
assert_eq!(missing_value, Ok(None));

pub fn set<S, V>(&self, path: &[S], value: V)

where S: AsRef<str>, V: Into<Value>,

Set a runtime override for a config option.

See Self::reset for clearing runtime overrides.

Example

use configory::Manager;

let manager = Manager::new("configory", ()).unwrap();

manager.set(&["option"], 3);

pub fn reset<S>(&self, path: &[S])

where S: AsRef<str>,

Clear the runtime override for a config option.

See Self::set for setting runtime overrides.

Example

use configory::Manager;

let manager = Manager::new("configory", ()).unwrap();

assert_eq!(manager.get::<_, i32>(&["option"]), Ok(Some(3)));
manager.reset(&["option"]);
assert_eq!(manager.get::<_, i32>(&["option"]), Ok(None));

pub fn persist(&self) -> Result<(), Error>

Persist the current runtime config to the config file.

Example

use configory::Manager;


let manager = Manager::new("configory", ()).unwrap();
manager.set(&["option"], 3);
manager.persist().unwrap();

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.