5 releases
0.2.0 | Feb 25, 2023 |
---|---|
0.1.3 | Feb 11, 2023 |
0.1.2 | Dec 24, 2022 |
0.1.1 | Dec 16, 2022 |
0.1.0 | Dec 16, 2022 |
#528 in Configuration
36KB
890 lines
Kōsei
こうせい
A easy-to-use configuration crate with the Rust programming language.
Features
-
Supports:
toml
,yaml
,json
configuration type.- Apollo config
- Nacos
-
Dynamic configuration
- hot reload
- support from local file, Apollo config, Nacos
Features
dynamic | hot-reload config support |
---|---|
apollo | Apollo support |
nacos | Nacos support |
Quickstart
See
examples
for further use.
Config Entry
// `Deserialize` and `Clone` traits should be applied
#[derive(Clone, Debug, Deserialize)]
struct Entry {
...
}
- Base file config
#[test]
fn base_test() {
// Panic if no such file `config/config.yaml`
let config: Config<Entry> = Config::from_file("config/config.yaml");
let entry: &Entry = config.as_inner(); // borrowed value has the same lifetimes as config
let entry: Entry = config.to_inner(); // clone a new Entry
let entry: Entry = config.into_inner(); // take ownership
}
- Dynamic file config
#[tokio::test]
async fn dynamic_test() {
// Create a dynamic config and a watcher
let (config, mut watcher) = DynamicConfig::<Entry>::watch_file("config/config.yaml");
// Listen to file modify event
watcher.watch().unwrap();
let lock = config.lock();
let entry: &Entry = lock.as_inner(); // borrow Entry
let entry: Entry = lock.to_inner(); // clone a new Entry
// let entry: Entry = lock.into_inner(); panic! cannot take the lock ownership
let arc = config.as_arc(); // clone a new arc
// Stop watching
watcher.stop().unwrap();
// You can watch twice
watcher.watch().unwrap();
}
- Dynamic Apollo config
use kosei::apollo::{Builder, WatchMode};
use kosei::{ConfigType, DynamicConfig, InnerWatcher};
use serde::Deserialize;
use std::time::Duration;
#[derive(Deserialize, Clone, Debug)]
struct Entry {
x: f64,
y: f64,
}
#[tokio::main]
async fn main() {
let client = Builder::new()
.app_id("test")
.namespace("test", ConfigType::YAML)
.server_url("http://localhost:8080")
.finish();
let (config, mut watcher) =
DynamicConfig::<Entry>::watch_apollo(client, WatchMode::RealTime).await;
watcher.watch().unwrap();
{
let guard = config.lock();
println!("entry: {:?}", guard.as_inner());
}
tokio::time::sleep(Duration::from_secs(10)).await;
{
let guard = config.lock();
println!("entry: {:?}", guard.as_inner());
}
}
Dependencies
~9–24MB
~337K SLoC