2 key
crate-kit edited this page 2026-11-11 11:00:01 +00:00

pmoconfig > key

Module: key

Contents

Structs

  • Key - Une clé déclarée : son chemin, son type et son défaut. Se déclare en const dans la crate qui

Enums

  • DefaultValue - Le défaut d'une clé déclarée, constructible en const.
  • Kind - Le type d'une clé : d'où la validation de ce qu'on y écrit.

pmoconfig:🔑:DefaultValue

Enum

Le défaut d'une clé déclarée, constructible en const.

Variants:

  • Bool(bool) - Un booléen.
  • Integer(i64) - Un entier.
  • Float(f64) - Un nombre à virgule.
  • List(&'static [&'static str]) - Une liste de textes.
  • Text(&'static str) - Un texte.
  • Unset - Pas de défaut : « non défini » est un état normal (un identifiant, un secret). Lire la clé

Methods:

  • fn to_value(self: Self) -> Option<Value> - Le défaut comme valeur de l'arbre de configuration ; None s'il n'y en a pas (Unset).

Traits: Copy

Trait Implementations:

  • PartialEq
    • fn eq(self: &Self, other: &Self) -> bool
  • Clone
    • fn clone(self: &Self) -> Self
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private229::Result<<__S as >::Ok, <__S as >::Error>
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

pmoconfig:🔑:Key

Struct

Une clé déclarée : son chemin, son type et son défaut. Se déclare en const dans la crate qui possède la clé, et s'emploie telle quelle par l'accesseur, par le registre (ConfigKeys) et par la page de configuration.

Fields:

  • path: &'static [&'static str] - Le chemin dans l'arbre (&["host", "logger", "min_level"]).
  • kind: Kind - Le type, les bornes ou les options.
  • default: DefaultValue - La valeur d'une clé que le fichier ne porte pas.
  • unit: &'static str - L'unité d'un entier ("jours", "minutes"), vide s'il n'y en a pas. Elle fait partie du

Methods:

  • fn new(path: &'static [&'static str], kind: Kind, default: DefaultValue) -> Self - Une clé de type et de défaut quelconques. default_is_valid dit
  • fn unit(self: Self, unit: &'static str) -> Self - Donne une unité à la clé ("jours", "minutes", "ms").
  • fn text(path: &'static [&'static str], default: &'static str) -> Self - Un texte libre.
  • fn integer(path: &'static [&'static str], default: i64, min: Option<i64>, max: Option<i64>) -> Self - Un entier avec des bornes facultatives.
  • fn list(path: &'static [&'static str], default: &'static [&'static str]) -> Self - Une liste de textes, avec ses éléments par défaut.
  • fn float(path: &'static [&'static str], default: f64, min: Option<f64>, max: Option<f64>) -> Self - Un nombre à virgule avec des bornes facultatives.
  • fn bounded(path: &'static [&'static str], default: i64, min: i64, max: i64) -> Self - Un entier compris entre deux bornes incluses (raccourci de integer pour
  • fn bool(path: &'static [&'static str], default: bool) -> Self - Un booléen.
  • fn optional_text(path: &'static [&'static str]) -> Self - Un texte optionnel, sans défaut : « non défini » est normal (un identifiant).
  • fn secret(path: &'static [&'static str]) -> Self - Un secret (mot de passe, jeton), sans défaut : jamais montré, seulement « défini » ou non.
  • fn choice(path: &'static [&'static str], default: &'static str, options: &'static [&'static str]) -> Self - Un texte à prendre dans une liste fermée.
  • fn dotted_path(self: &Self) -> String - Le chemin, niveaux séparés par des points.
  • fn default_is_valid(self: &Self) -> bool - Le défaut respecte-t-il le type, les bornes et les options de la clé ?

Traits: Copy

Trait Implementations:

  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private229::Result<<__S as >::Ok, <__S as >::Error>
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
  • PartialEq
    • fn eq(self: &Self, other: &Self) -> bool
  • Clone
    • fn clone(self: &Self) -> Self

pmoconfig:🔑:Kind

Enum

Le type d'une clé : d'où la validation de ce qu'on y écrit.

Variants:

  • Text - Du texte libre.
  • Integer{ min: Option<i64>, max: Option<i64> } - Un entier, avec des bornes facultatives (incluses).
  • Float{ min: Option<f64>, max: Option<f64> } - Un nombre à virgule (fini), avec des bornes facultatives (incluses). Un entier écrit dans le
  • Bool - Un booléen.
  • Choice{ options: &'static [&'static str] } - Un texte à prendre dans une liste fermée (la casse est libre).
  • List - Une liste de textes non vides (des portées, des domaines). Dans le fichier : une séquence YAML, ou un
  • Secret - Un secret (mot de passe, jeton) : un texte que la page ne montre jamais, seulement « défini »

Methods:

  • fn check(self: &Self, value: &Value) -> Result<(), String> - Cette valeur a-t-elle le type, et reste-t-elle dans les bornes ou les options ?
  • fn coerce(self: &Self, value: Value) -> Value - La valeur écrite dans le fichier telle que la lit la configuration : un entier écrit comme

Traits: Copy

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> Self
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private229::Result<<__S as >::Ok, <__S as >::Error>
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
  • PartialEq
    • fn eq(self: &Self, other: &Self) -> bool