5 config
crate-kit edited this page 2026-11-16 08:44:02 +00:00

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 configuration
  • fn source_of(self: &Self, path: &[&str], default: Option<&Value>) -> Source - D'où vient la valeur effective de path : 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 le
  • fn 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 passe encrypted:… 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 que
  • fn entries(self: &Self, pattern: &[&str]) -> Result<Vec<Entry>> - Les entrées de la collection que décrit pattern, dans l'ordre du fichier. Un segment du motif est
  • fn read_value(self: &Self, key: &Key) -> Result<Value> - La valeur effective de key : celle de l'arbre (surcharges d'environnement comprises) si
  • fn read_optional_text(self: &Self, key: &Key) -> Result<Option<String>> - La valeur effective de key si elle est écrite, None sinon, sans retomber sur un défaut :
  • fn read_secret(self: &Self, key: &Key) -> Result<Option<String>> - Le secret de key (clé de type secret, Key::secret), déchiffré ; None s'il n'est pas
  • fn check_key(self: &Self, key: &Key) -> Result<()> - Vérifie ce qui est écrit pour key, sans lire de défaut : une clé absente est valide (elle
  • fn read_text(self: &Self, key: &Key) -> Result<String> - Le texte de key (clé de type texte ou liste fermée).
  • fn read_integer(self: &Self, key: &Key) -> Result<i64> - L'entier de key (clé de type entier ou curseur).
  • fn read_float(self: &Self, key: &Key) -> Result<f64> - Le nombre à virgule de key (clé de type flottant). Un entier écrit dans le fichier est lu
  • fn write_value(self: &Self, key: &Key, value: Value) -> Result<()> - Écrit value à la clé key aprè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é comme write_value).
  • fn write_integer(self: &Self, key: &Key, integer: i64) -> Result<()> - Écrit un entier à la clé key (validé comme write_value).
  • fn read_list(self: &Self, key: &Key) -> Result<Vec<String>> - La liste de textes de key (clé de type liste). Un texte écrit dans le fichier est lu comme la liste de
  • fn write_list(self: &Self, key: &Key, items: &[String]) -> Result<()> - Écrit une liste de textes à la clé key (validée comme write_value).
  • fn write_float(self: &Self, key: &Key, number: f64) -> Result<()> - Écrit un nombre à virgule à la clé key (validé comme write_value).
  • fn managed_dir_of(self: &Self, key: &Key) -> Result<String> - Le dossier désigné par key (clé de type texte) : absolu, ou relatif au dossier de
  • fn read_bool(self: &Self, key: &Key) -> Result<bool> - Le booléen de key.
  • 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 de config.yaml) : là où une
  • fn 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 dans config.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 configuration
  • fn set_managed_dir(self: &Self, path: &[&str], directory: &str) -> Result<()> - Définit un répertoire géré par la configuration
  • fn get_number(self: &Self, path: &[&str]) -> Result<Option<f64>> - Le nombre à path, ou None si rien n'y est. Une valeur qui n'est pas un nombre est une
  • fn get_integer(self: &Self, path: &[&str]) -> Result<Option<i64>> - L'entier à path, ou None si rien n'y est. Un nombre à virgule est refusé, sauf s'il est
  • fn get_string(self: &Self, path: &[&str]) -> Result<Option<String>> - La chaîne à path, ou None si rien n'y est. Une chaîne vide compte pour absente ; une
  • fn get_bool(self: &Self, path: &[&str]) -> Result<Option<bool>> - Le booléen à path, ou None si rien n'y est.
  • fn get_number_or_set(self: &Self, path: &[&str], default: f64) -> Result<f64> - Le nombre à path ; absent, default est écrit à ce chemin puis retourné. Un défaut entier
  • fn get_integer_or_set(self: &Self, path: &[&str], default: i64) -> Result<i64> - L'entier à path ; absent, default est é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), default est écrit à ce chemin puis retourné.
  • fn get_bool_or_set(self: &Self, path: &[&str], default: bool) -> Result<bool> - Le booléen à path ; absent, default est é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