Struct Manager 

pub struct Manager { /* private fields */ }

Configuration manager.

Example

use configory::Manager;

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

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

Implementations

impl Manager

pub fn new<S: AsRef<str>, E, D>( namespace: S, event_handler: E, ) -> Result<Self, Error>

where E: EventHandler<D>, D: DeserializeOwned,

Initialize the configuration manager.

This will spawn multiple background threads and create socket files. See Self::with_options to control the enabled features.

Example

use configory::Manager;

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

pub fn with_options<E, D>( options: &Options<'_>, event_handler: E, ) -> Result<Self, Error>

where E: EventHandler<D>, D: DeserializeOwned,

Initialize the configuration manager with some features disabled.

See Self::new if you want all the features available.

Example

use configory::{Manager, Options};

// Create a config without IPC.
let options = Options::new("configory").notify(true);
let manager = Manager::with_options(&options, ()).unwrap();

pub fn ipc(&self) -> Option<&Ipc>

Get an IPC handle.

Will be None only if IPC was disabled using Self::with_options.

Example

use configory::{Manager, Options};

let manager = Manager::new("configory", ()).unwrap();
assert!(manager.ipc().is_some());

let options = Options::new("configory");
let manager = Manager::with_options(&options, ()).unwrap();
assert!(manager.ipc().is_none());

Methods from Deref<Target = 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 Deref for Manager

type Target = Config

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.