Table of contents
- pmoconfig
- pmoconfig — configuration YAML d'une application
- Utilisation
- Modules
- pmoconfig
- config
- config::Config
- encryption
- entries
- error
- global
- introspect
- key
- key::Key
- key::Kind
- page
- page::ConfigPage
- page::Setting
- page::action
- page::check
- page::collection
- page::collection::Collection
- page::collection_view
- page::info
- page::restart
- page::view
- registry
- registry::ConfigKeys
- spec
- spec::AppSpec
pmoconfig
pmoconfig — configuration YAML d'une application
Une configuration est un arbre YAML lu et écrit par chemin, avec :
- un fichier
config.yamldans un dossier de configuration ; - une configuration par défaut fusionnée avec ce fichier, et écrite seule dans un fichier neuf ;
- des surcharges par variables d'environnement ;
- des lecteurs typés (nombre, chaîne, booléen), des dossiers gérés (créés au besoin) ;
- le chiffrement des mots de passe, avec une clé dérivée de la machine ;
- des pages web d'édition, en option (feature
webui).
La crate ne connaît aucune application. Une application se décrit par un AppSpec (un
préfixe et un YAML par défaut), dont découlent le nom du dossier, les variables d'environnement
et les sels de chiffrement. Les réglages d'un domaine (un port, un cache…) s'ajoutent à
Config par un trait d'extension défini dans la crate du domaine.
Utilisation
use pmoconfig::{AppSpec, Config};
use serde_yaml_ng::Value;
let dir = tempfile::tempdir()?;
let spec = AppSpec::new("MONAPP");
let config = Config::load(&spec, dir.path().to_str().unwrap())?;
config.set_value(&["host", "port"], Value::Number(8080.into()))?;
assert_eq!(config.get_value(&["host", "port"])?, Value::Number(8080.into()));
# Ok::<(), Box<dyn std::error::Error>>(())
Un processus qui veut une configuration globale appelle init au début de main, puis
get_config partout ailleurs (ou try_get_config si l'ordre d'initialisation n'est pas garanti).
Modules
pmoconfig
2 modules
config
1 struct
config::Config
15 functions
encryption
1 constant, 1 function
entries
1 constant, 1 struct
error
1 enum, 1 type alias
global
4 functions
introspect
1 enum
key
1 struct, 2 enums
key::Key
3 functions
key::Kind
1 function
page
3 enums, 3 structs
page::ConfigPage
1 function
page::Setting
5 functions
page::action
2 structs
page::check
1 struct
page::collection
1 enum, 3 structs
page::collection::Collection
2 functions
page::collection_view
5 structs
page::info
2 structs
page::restart
1 struct
page::view
2 structs
registry
1 struct
registry::ConfigKeys
1 function
spec
1 struct
spec::AppSpec
5 functions
pmoconfig 0.3.5
- pmoconfig
- config
- config::Config
- encryption
- entries
- error
- global
- introspect
- key
- key::Key
- key::Kind
- page
- page::ConfigPage
- page::Setting
- page::action
- page::check
- page::collection
- page::collection::Collection
- page::collection_view
- page::info
- page::restart
- page::view
- registry
- registry::ConfigKeys
- spec
- spec::AppSpec