Table of contents
pmoconfig > config
Module: config
Contents
Structs
Config- Gestionnaire de configuration d'une application.
pmoconfig::config::Config
Struct
Gestionnaire de configuration d'une application.
Il lit config.yaml dans le dossier de configuration, le fusionne avec la configuration par
défaut de l'application (AppSpec), applique les surcharges d'environnement, puis offre
l'accès à l'arbre par chemin (&["host", "port"]) ; chaque écriture est sauvegardée aussitôt.
Les clés sont insensibles à la casse (elles sont mises en minuscules).
Les surcharges d'environnement l'emportent à la lecture mais ne sont jamais écrites dans le fichier. Écrire une clé surchargée met à jour le fichier, mais la lecture continue de rendre la surcharge tant que la variable est définie.
Les réglages propres à un domaine (un port, un cache…) ne sont pas ici : chaque crate les
ajoute à Config avec un trait d'extension, au-dessus de get_value,
set_value, des lecteurs typés (get_number, get_string…) et de
get_managed_dir.
Exemple
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()));
config.set_value(&["host", "port"], Value::Number(9000.into()))?;
# Ok::<(), Box<dyn std::error::Error>>(())
Methods:
fn declare(self: &Self, keys: ConfigKeys) -> Result<(), Vec<PmoConfigError>>- Déclare les clés du binaire : vérifie d'abord toute la configurationfn source_of(self: &Self, path: &[&str], default: Option<&Value>) -> Source- D'où vient la valeur effective depath: une variable d'environnement qui la surcharge,fn set_values(self: &Self, values: &[(&[&str], Value)]) -> Result<()>- Écrit plusieurs valeurs d'un coup : toutes sont appliquées sous un même verrou, puis lefn encrypt_password(self: &Self, password: &str) -> Result<String, PmoConfigError>- Chiffre un mot de passe avec la clé de cette installation.fn decrypt_password(self: &Self, encrypted: &str) -> Result<String, PmoConfigError>- Déchiffre un mot de passeencrypted:…avec la clé de cette installation. N'en crée jamais :fn get_password(self: &Self, value: &str) -> Result<String, PmoConfigError>- Le mot de passe en clair, qu'il soit chiffré ou non.fn get_secret(self: &Self, path: &[&str]) -> Result<String, PmoConfigError>- Le mot de passe écrit àpath, chiffré sur place s'il était encore en clair.fn prune_defaults(self: &Self) -> Result<Vec<String>>- Retire du fichier les valeurs égales au défaut de leur clé déclarée (celui quefn entries(self: &Self, pattern: &[&str]) -> Result<Vec<Entry>>- Les entrées de la collection que décritpattern, dans l'ordre du fichier. Un segment du motif estfn read_value(self: &Self, key: &Key) -> Result<Value>- La valeur effective dekey: celle de l'arbre (surcharges d'environnement comprises) sifn read_optional_text(self: &Self, key: &Key) -> Result<Option<String>>- La valeur effective dekeysi elle est écrite,Nonesinon, sans retomber sur un défaut :fn read_secret(self: &Self, key: &Key) -> Result<Option<String>>- Le secret dekey(clé de type secret,Key::secret), déchiffré ;Nones'il n'est pasfn check_key(self: &Self, key: &Key) -> Result<()>- Vérifie ce qui est écrit pourkey, sans lire de défaut : une clé absente est valide (ellefn read_text(self: &Self, key: &Key) -> Result<String>- Le texte dekey(clé de type texte ou liste fermée).fn read_integer(self: &Self, key: &Key) -> Result<i64>- L'entier dekey(clé de type entier ou curseur).fn read_float(self: &Self, key: &Key) -> Result<f64>- Le nombre à virgule dekey(clé de type flottant). Un entier écrit dans le fichier est lufn write_value(self: &Self, key: &Key, value: Value) -> Result<()>- Écritvalueà la clékeyaprès l'avoir validée (type, bornes, options), puis sauvegarde.fn write_text(self: &Self, key: &Key, text: &str) -> Result<()>- Écrit un texte à la clékey(validé commewrite_value).fn write_integer(self: &Self, key: &Key, integer: i64) -> Result<()>- Écrit un entier à la clékey(validé commewrite_value).fn read_list(self: &Self, key: &Key) -> Result<Vec<String>>- La liste de textes dekey(clé de type liste). Un texte écrit dans le fichier est lu comme la liste defn write_list(self: &Self, key: &Key, items: &[String]) -> Result<()>- Écrit une liste de textes à la clékey(validée commewrite_value).fn write_float(self: &Self, key: &Key, number: f64) -> Result<()>- Écrit un nombre à virgule à la clékey(validé commewrite_value).fn managed_dir_of(self: &Self, key: &Key) -> Result<String>- Le dossier désigné parkey(clé de type texte) : absolu, ou relatif au dossier defn read_bool(self: &Self, key: &Key) -> Result<bool>- Le booléen dekey.fn spec(self: &Self) -> &AppSpec- L'application à laquelle appartient cette configuration.fn config_dir(self: &Self) -> &str- Le dossier de configuration de cette instance (celui deconfig.yaml) : là où unefn resolve_config_dir(spec: &AppSpec, directory: &str) -> Result<String>- Cherche, crée au besoin et vérifie le dossier de configuration.fn load(spec: &AppSpec, directory: &str) -> Result<Self>- Charge la configuration d'une application.fn save(self: &Self) -> Result<()>- Écrit la configuration dansconfig.yaml, sans les surcharges d'environnement.fn set_value(self: &Self, path: &[&str], value: Value) -> Result<()>- Écrit une valeur àpath(clés insensibles à la casse) puis sauvegarde le fichier.fn get_value(self: &Self, path: &[&str]) -> Result<Value>- Lit la valeur àpath(clés insensibles à la casse), surcharges d'environnement comprises.fn get_managed_dir(self: &Self, path: &[&str], default: &str) -> Result<String>- Récupère un répertoire géré par la configurationfn set_managed_dir(self: &Self, path: &[&str], directory: &str) -> Result<()>- Définit un répertoire géré par la configurationfn get_number(self: &Self, path: &[&str]) -> Result<Option<f64>>- Le nombre àpath, ouNonesi rien n'y est. Une valeur qui n'est pas un nombre est unefn get_integer(self: &Self, path: &[&str]) -> Result<Option<i64>>- L'entier àpath, ouNonesi rien n'y est. Un nombre à virgule est refusé, sauf s'il estfn get_string(self: &Self, path: &[&str]) -> Result<Option<String>>- La chaîne àpath, ouNonesi rien n'y est. Une chaîne vide compte pour absente ; unefn get_bool(self: &Self, path: &[&str]) -> Result<Option<bool>>- Le booléen àpath, ouNonesi rien n'y est.fn get_number_or_set(self: &Self, path: &[&str], default: f64) -> Result<f64>- Le nombre àpath; absent,defaultest écrit à ce chemin puis retourné. Un défaut entierfn get_integer_or_set(self: &Self, path: &[&str], default: i64) -> Result<i64>- L'entier àpath; absent,defaultest écrit à ce chemin puis retourné.fn get_string_or_set(self: &Self, path: &[&str], default: &str) -> Result<String>- La chaîne àpath; absente (ou vide),defaultest écrit à ce chemin puis retourné.fn get_bool_or_set(self: &Self, path: &[&str], default: bool) -> Result<bool>- Le booléen àpath; absent,defaultest écrit à ce chemin puis retourné.
Trait Implementations:
- Clone
fn clone(self: &Self) -> Self
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
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