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

pmoconfig > page

Module: page

Contents

Structs

  • ConfigPage - Une page de configuration : les réglages d'un domaine, déclarés par la crate qui le possède.
  • ConfigPages - Le registre des pages d'un binaire : il les assemble explicitement, une par crate
  • Setting - Un réglage scalaire : une clé de la configuration et ce qu'il faut pour la montrer.

Enums

  • Apply - Quand une valeur écrite est prise en compte.
  • Mode - Ce que l'éditeur permet de faire d'un réglage.
  • Widget - Comment un réglage est montré (et, plus tard, édité). C'est la présentation, pas le type : un

pmoconfig::page::Apply

Enum

Quand une valeur écrite est prise en compte.

Variants:

  • Live - Tout de suite : les consommateurs relisent la configuration à l'usage.
  • RestartRequired - Au prochain démarrage seulement (le réglage est lu une fois, au démarrage).

Traits: Eq, 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::page::ConfigPage

Struct

Une page de configuration : les réglages d'un domaine, déclarés par la crate qui le possède.

Fields:

  • id: &'static str - L'identifiant de la page, sans espace ni / : un segment d'URL.
  • title: &'static str - Le titre affiché.
  • description: &'static str - Une ou deux phrases qui disent à quoi sert la page, montrées dans l'index ; vide s'il n'y en a pas.
  • path: &'static [&'static str] - Où la page est rangée dans l'index (&["Sources", "Radios"]) ; vide : à la racine. Un simple
  • settings: Vec<Setting> - Les réglages, dans l'ordre où ils sont déclarés.
  • actions: Vec<Action> - Les actions (boutons), dans l'ordre où elles sont déclarées.
  • collections: Vec<Collection> - Les collections d'entrées, dans l'ordre où elles sont déclarées.
  • infos: Vec<Info> - Les lignes d'information (états du processus, pas des réglages), dans l'ordre où elles sont déclarées.
  • checks: Vec<Check> - Les vérifications entre réglages, lancées après l'écriture d'un formulaire (voir Check).

Methods:

  • fn new(id: &'static str, title: &'static str) -> Self - Une page sans réglage.
  • fn description(self: Self, description: &'static str) -> Self - Ajoute la description de la page, montrée dans l'index.
  • fn at(self: Self, path: &'static [&'static str]) -> Self - Range la page sous un chemin de l'index (&["Sources", "Radios"]). Les niveaux n'ont pas de
  • fn with(self: Self, setting: Setting) -> Self - Ajoute un réglage.
  • fn check<F>(self: Self, run: F) -> Self - Ajoute une vérification entre réglages : après avoir écrit un formulaire, pmoconfig appelle run
  • fn info(self: Self, info: Info) -> Self - Ajoute une ligne d'information : un état du processus, montré en lecture seule, jamais écrit ni
  • fn collection(self: Self, collection: Collection) -> Self - Ajoute une collection d'entrées.
  • fn action(self: Self, action: Action) -> Self - Ajoute une action.
  • fn view(self: &Self, config: &Config) -> Result<PageView> - La page avec les valeurs de config ; les réglages Hidden en sont absents.

Trait Implementations:

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

pmoconfig::page::ConfigPages

Struct

Le registre des pages d'un binaire : il les assemble explicitement, une par crate (ConfigPages::new().with(crate_a::config_page()).with(…)), sans enregistrement automatique.

Methods:

  • fn new() -> Self - Un registre vide.
  • fn with(self: Self, page: ConfigPage) -> Self - Ajoute une page.
  • fn restart(self: Self, hook: RestartHook) -> Self - Enregistre le crochet de redémarrage de l'hôte : l'éditeur offre alors un bouton
  • fn restart_hook(self: &Self) -> Option<&RestartHook> - Le crochet de redémarrage, s'il est enregistré.
  • fn get(self: &Self, id: &str) -> Option<&ConfigPage> - La page d'identifiant id.
  • fn iter(self: &Self) -> impl Trait - Les pages, dans l'ordre où elles ont été ajoutées.

Trait Implementations:

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

pmoconfig::page::Mode

Enum

Ce que l'éditeur permet de faire d'un réglage.

Variants:

  • Hidden - Ni montré ni modifiable.
  • ReadOnly - Montré, jamais modifiable (par exemple une clé que personne ne tape à la main).
  • Editable - Montré et modifiable.

Traits: Eq, Copy

Trait Implementations:

  • 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
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private229::Result<<__S as >::Ok, <__S as >::Error>

pmoconfig::page::Setting

Struct

Un réglage scalaire : une clé de la configuration et ce qu'il faut pour la montrer.

Il vient d'une clé déclarée (Setting::new) : type, bornes et défaut sont ceux de sa déclaration.

Fields:

  • path: &'static [&'static str] - Le chemin de la clé dans l'arbre (&["host", "logger", "min_level"]).
  • kind: crate::key::Kind - Le type de la valeur.
  • default: crate::key::DefaultValue - Le défaut déclaré (celui que l'application impose peut le remplacer : voir
  • unit: &'static str - L'unité de la valeur, vide s'il n'y en a pas (celle de la clé déclarée).
  • widget: Widget - Comment le réglage est montré ; Widget::Auto d'après le type, sauf demande contraire.
  • label: &'static str - Le libellé affiché.
  • help: &'static str - Une phrase d'aide ; vide s'il n'y en a pas.
  • group: Option<&'static str> - Le titre de la section de la page où ranger ce réglage ; les réglages sans groupe viennent
  • mode: Mode - Ce que l'éditeur permet d'en faire.
  • apply: Apply - Quand une écriture est prise en compte.

Methods:

  • fn new(key: Key, label: &'static str) -> Self - Un réglage pour une clé déclarée : éditable, pris en compte à chaud, sans aide ni groupe.
  • fn help(self: Self, help: &'static str) -> Self - Ajoute une phrase d'aide.
  • fn group(self: Self, group: &'static str) -> Self - Range le réglage dans une section de la page.
  • fn mode(self: Self, mode: Mode) -> Self - Change ce que l'éditeur permet d'en faire.
  • fn restart_required(self: Self) -> Self - Marque le réglage comme lu une seule fois, au démarrage.
  • fn slider(self: Self) -> Self - Montre un entier à deux bornes comme un curseur.
  • fn checkbox(self: Self) -> Self - Montre un booléen comme une case à cocher plutôt que comme un interrupteur.
  • fn words(self: Self, on: &'static str, off: &'static str) -> Self - Donne leurs mots aux deux positions d'un interrupteur ("oui", "non").
  • fn resolved_widget(self: &Self) -> Widget - Comment le réglage est montré, Widget::Auto résolu d'après le type.
  • fn dotted_path(self: &Self) -> String - Le chemin, niveaux séparés par des points.
  • fn view(self: &Self, config: &Config) -> Result<SettingView> - Ce réglage avec ses valeurs lues dans config.

Trait Implementations:

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

pmoconfig::page::Widget

Enum

Comment un réglage est montré (et, plus tard, édité). C'est la présentation, pas le type : un même entier peut être un champ numérique ou un curseur.

Auto laisse la page choisir d'après le type de la clé ; les autres variantes l'imposent, et ne vont qu'avec un type compatible (voir Setting::slider et Setting::words).

Variants:

  • Auto - D'après le type : texte, nombre, interrupteur on / off, ou liste.
  • Text - Un champ de texte.
  • Number - Un champ numérique.
  • Slider - Un curseur entre les deux bornes d'un entier.
  • Checkbox - Une case à cocher (en édition) ; oui / non en lecture. Le défaut d'un booléen est l'interrupteur
  • Toggle{ on: &'static str, off: &'static str } - Un interrupteur dont les deux positions portent un mot.
  • Choice - Les options d'une liste fermée.
  • Secret - Un secret : jamais la valeur, seulement « défini » ou « non défini ».

Traits: Eq, 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