Files
mytheclipse/crates/mytheclipse-config/README.md
T

50 lines
1.3 KiB
Markdown
Raw Normal View History

# mytheclipse-config
Type-safe, dynamic configuration: load `.env`, YAML, JSON, or TOML directly
into a typed Rust struct, merge multiple sources with environment variables
taking priority, and optionally hot-reload when the source files change.
## Features
- `env` (default) — `.env` file loading via `dotenvy`.
- `yaml` / `toml` (default) — structured file parsing (`.json` is always available).
- `hot-reload` (default) — watch files and swap in a freshly reloaded value.
## Usage
```rust
use serde::Deserialize;
use mytheclipse_config::ConfigLoader;
#[derive(Debug, Deserialize, Clone)]
struct AppConfig {
port: u16,
database_url: String,
}
let config: AppConfig = ConfigLoader::new()
.merge_file("config.yaml".as_ref())?
.merge_env("APP") // APP_PORT, APP_DATABASE_URL override the file
.build()?;
```
### Hot-reload
```rust
use mytheclipse_config::DynamicConfig;
# use serde::Deserialize;
# #[derive(Debug, Deserialize, Clone)] struct AppConfig { port: u16 }
let cfg = DynamicConfig::<AppConfig>::watch_files(
vec!["config.yaml".into()],
|| mytheclipse_config::ConfigLoader::new().merge_file("config.yaml".as_ref())?.build(),
)?;
let mut changes = cfg.subscribe();
tokio::spawn(async move {
while changes.recv().await.is_ok() {
println!("config reloaded: {:?}", cfg.get());
}
});
```