Struct viperus::Viperus

pub struct Viperus<'a> { /* fields omitted */ }

A unified config Facade

Viperous manage config source from files, env and command line parameters in a unified manner

Methods

impl<'v> Viperus<'v>

pub fn new() -> Self

pub fn load_clap(
    &mut self,
    matches: ArgMatches<'v>
) -> Result<(), Box<dyn Error>>

load_clap brings in the clap magic

pub fn reload(&mut self) -> Result<(), Box<dyn Error>>

reload all config file preserving the order

pub fn loaded_file_names(&self) -> Vec<String>

pub fn load_file(
    &mut self,
    name: &str,
    format: Format
) -> Result<(), Box<dyn Error>>

load_file load a config file using one of the preconfigured addapters then applay the adatpter using load_adapter method

pub fn load_adapter(
    &mut self,
    adt: &mut dyn ConfigAdapter
) -> Result<(), Box<dyn Error>>

load_adapter ask the adapter to parse her data and merges result map in the internal configartion map

pub fn get<'a, 'b, 'c, T>(&'a self, key: &'b str) -> Option<T> where
    ViperusValue: From<T>,
    &'c ViperusValue: Into<T>,
    ViperusValue: Into<T>,
    T: FromStr,
    T: Clone, 

get a configuration value of type T in this order

• overrided key
• clap parameters
• config adapter sourced values

pub fn add<'a, T>(&'a mut self, key: &'a str, value: T) -> Option<T> where
    ViperusValue: From<T>,
    ViperusValue: Into<T>, 

add an override value to the cofiguration

key is structured in components separated by a "."

pub fn bond_clap(&mut self, src: &str, dst: &str) -> Option<String>

pub fn add_default<'a, T>(&'a mut self, key: &'a str, value: T) -> Option<T> where
    ViperusValue: From<T>,
    ViperusValue: Into<T>, 

add an default value to the configuration

key is structured in components separated by a "."

pub fn cache(&mut self, enable: bool)

cache the query results for small configs speedup is x4

Trait Implementations

impl<'a> Debug for Viperus<'a>

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

Formats the value using the given formatter.

impl<'v> Default for Viperus<'v>

fn default() -> Self

Returns the "default value" for a type.