Skip to content

Configuration loader for Rust, aka: derive(Config)

Notifications You must be signed in to change notification settings

ramiroaisen/metre

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

metre: The rust configuration loader

AKA: #[derive(Config)]

crates.io build unit-tests integration-tests docs

What is it?

metre is a configuration loader for Rust that allows you to load configurations from a variety of formats such as toml, json, jsonc and yaml

It also supports a variety of sources such as program defaults, env variables, files, and urls.

Usage

use metre::{Config, ConfigLoader, Format};

#[derive(Config)]
struct MyConfig {
  #[config(default = 8000)]
  port: u16,
  foo: String
}

let mut loader = ConfigLoader::<MyConfig>::new();

loader.defaults()?;
loader.file("config.json", Format::Json)?;
loader.env()?;

// config have the type MyConfig here
let config = loader.finish()?;  

Focus

metre focus is to provide a declarative and type-safe way to load configurations in Rust.

How?

metre works by defining a struct that implements the Config trait, usually via the #[derive(Config)] macro.

Under the hood metre creates deep partial version of the struct to accumulate the configuration from different sources.

Once all the configuration is accumulated, you can access the final configuration as the defined struct. If the sum of all sources does not comply with the required properties, metre will return an error.

Install

cargo add metre

Docs

https://docs.rs/metre

About

Configuration loader for Rust, aka: derive(Config)

Resources

Stars

Watchers

Forks

Packages

No packages published