̶g̶o̶ rust configuration with fangs!
viperus is an (in)complete configuration solution for Rust applications. inspired heavly inspired by the wonderful go package https://github.com/spf13/viper use at your own risk. ;-)
no Go projects h̶a̶s̶ ̶b̶e̶e̶n̶ ̶h̶a̶r̶m̶e̶d̶ are built using Viperus :-)
a package that handles some types of configuration modes with differente formats,cli params and enviroment . It supports:
beacuse I was migrating some go apps... and a was missing Viper ease of use :-)
Viperus uses the following decreasing precedence order.
addViperus merge configuration from toml,dotenv,json,yaml files and clap options in sigle typed hash structure. with defaults, and type checking
you can create a stand alone Viperus object or "enjoy" a global instance ( thread safe protected with a mutex) via shadow functions loadfile|get|add|loadclap that are routed to the static instance.
```rust //add a config file & enviroment variables viperus::loadfile(".env", viperus::Format::ENV).unwrap(); //add another file viperus::loadfile("user.env", viperus::Format::ENV).unwrap();
//watch the config and autoreload if something changes viperus::watch_all();
//enable caching -- file reload invalidates cache
// cache i thread safe for the global "static" instance
viperus::cache(true);
let ok=viperus::get::
you can enable caching for a x4 speed-up.
cache is thread safe only when used with the global instance taht is behing a arc mutex
rust
viperus::cache(true);
reloading files with an excplicit viperus::reload() ,
or for effect of a file change when file watch is active invalidates the cache.
the crate uses log facade , and test the env_logger you can set the env variable to RUSTLOG=viperus=[DEBUG LEVEL] with
[DEBUG LEVEL] = info|warning|debug or RUSTLOG=[DEBUG LEVEL]
the crate in "fetaureized" with the feaures enabled by default * feature = "fmt-[format]" with [format] in 'json,end,toml,yaml,javaproperties,clap' enabling the realtive format * feature ="global" enabling the global tread safe configuration * feature ="watch" enabling the automatic file reload wirh prerequisite feature=global * feature ="cache" aneglig caching
single featues could be activated in a selective way via cargo.toml
``` [dependencies.viperus] version = "0.1.5" default-features = false # do not include the default features, and optionally
features = ["global", "cache","watch","fmt-yaml"] ```
you can find some integration tests in the test dir and also in the example folder
you can run example with cargo:
cargo run --example cli-clap-yaml --
cargo run --example cli-clap-yaml -- -u http://nowhere/api/v1
the first run print the value from the example.yaml file
the second from the cli arg
```rust
let matches = App::new("My Super Program")
.arg(Arg::withname("v")
.short("v")
.multiple(true)
.help("Sets the level of verbosity"))
.getmatches();
let mut v = Viperus::new();
//enable clap v.loadclap(matches); //enable a yaml json toml file v.loadfile(&path!(".","assets","test.yaml"), Format::YAML).unwrap(); v.loadfile(&path!(".","assets","test.json"), Format::JSON).unwrap(); v.loadfile(&path!(".","assets","test.toml"), Format::TOML).unwrap(); v.loadfile(&path!(".","assets","test.properties"), Format::JAVAPROPERTIES).unwrap(); //link the "v" clap option to the key "verbose" v.bondclap("v","verbose");
//add an explicit overload v.add("service.url", String::from("http://example.com")); debug!("final {:?}", v);
//get a typed key let s: &str = v.get("service.url").unwrap(); assert_eq!("http://example.com", s);
//get a bool from configs or app args
let fVerbose=v.get::
```