Struct miau::configuration::Configuration

pub struct Configuration { /* fields omitted */ }

Owns configuration trees built from all sources.

Allows retrieving data stored in all trees, merging them, creating lenses and converting into strongly typed structs. Configuration should only be created by builder or sources. Most functions are public to server most bizzare needs.

To read values from Configuration you need to pull ConfigurationRead in scope.

Example

use miau::configuration::{Configuration, ConfigurationRead};

let configuration = Configuration::default(); //  aka empty
let word: Option<String> = configuration.get("word");
assert_eq!(None, word);

Implementations

impl Configuration

pub fn new_singular(info: ConfigurationInfo, root: ConfigurationTree) -> Self

Creates new Configuration from one tree and its associated information.

pub fn new_empty() -> Self

Creates new empty Configuration.

pub fn lens(&self) -> Lens<'_>

Creates Lens from this Configuration.

pub fn try_convert_into<T: DeserializeOwned>(
    self
) -> Result<T, ConfigurationError>

Deserializes Configuration into strongly typed struct.

It is only required that struct to be deserialized to implements Deserialize and contains no borrowed fields, for instance &str. Due to memory model of miau it is impossible to deserialize into such fields.

pub fn merge_owned(self) -> Result<ConfigurationTree, ConfigurationError>

Merges trees contained in Configuration into one tree by consuming them.

To merge cloned, invoke lens function first.

pub fn infos(&self) -> impl Iterator<Item = &ConfigurationInfo>

Retrives information about configuration trees, in order used internally by Configuration.

let configuration = Configuration::default(); // normally populated configuration should be used!

for info in configuration.infos() {
     println!("{}", info);
}

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'config, T, K> ConfigurationRead<'config, T, K> for Configuration where
    T: TryFrom<&'config Value, Error = ConfigurationError>,
    K: TryInto<CompoundKey, Error = ConfigurationError>, 

fn get_result(&'config self, keys: K) -> Result<Option<T>, ConfigurationError>

Retrieves value stored in ConfigurationTree under given keys.

fn get(&'config self, keys: K) -> Option<T>

Retrieves value stored in configuration under given keys.

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Configuration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'config> From<&'config Configuration> for Lens<'config>

fn from(config: &'config Configuration) -> Self

Performs the conversion.

impl From<ConfigurationTree> for Configuration

fn from(node: ConfigurationTree) -> Self

Performs the conversion.

impl From<HashMap<String, String, RandomState>> for Configuration

fn from(map: HashMap<String, String>) -> Self

Performs the conversion.

impl Provider for Configuration

fn collect(&self) -> Result<Configuration, ConfigurationError>

Collects given source into Configuration.

fn describe(&self) -> ConfigurationInfo

Describes this provider.