Module settings 

The class catalogue and the effective-config document.

One table lists every key the loader accepts, the area it draws in and when an edit to it takes effect; each entry also resolves its own value from a LoadedConfig. The reload summary and the settings page both read that table, so a key cannot be live in one and next-session in the other.

Re-exports

use std::collections::BTreeSet; 🔒

use std::path::Path; 🔒

use forge_primitives::settings::SettingsTotals; 🔒

use forge_primitives::EditKind; 🔒

use forge_primitives::EffectClass; 🔒

use forge_primitives::SettingKind; 🔒

use forge_primitives::SettingsArea; 🔒

use forge_primitives::SettingsDocument; 🔒

use forge_primitives::SettingsEdit; 🔒

use forge_primitives::SettingsKey; 🔒

use serde_json::json; 🔒

use crate::config::ConfigReload; 🔒

use crate::config::DEFAULT_HANDOFF_AFTER_COMPACTIONS; 🔒

use crate::config::DEFAULT_HANDOFF_AT_PERCENT; 🔒

use crate::config::DEFAULT_MAX_WORKERS_PER_PROJECT; 🔒

use crate::config::LoadedConfig; 🔒

use crate::config::LoadedProject; 🔒

use crate::config::format_session_duration; 🔒

Structs

AreaSpec

One area’s fixed identity: the id the page keys on, the name it draws, and the line under it.

CatalogueKeyTarget 🔒

One catalogue pattern’s own metadata, for a key the config does not set and therefore emits no row for.

ConfigKey

One accepted key: its pattern, the area it draws in, its class, and the rows it resolves to for a load.

EditSpec 🔒

One key’s edit metadata, in the catalogue’s own static form.

KeyRow 🔒

One row a catalogued key resolves to: a concrete path (with the instance where the table repeats) and the effective value.

SettingsTarget 🔒

One key a settings tool can address: the document row the writer would locate, with everything an edit needs to be built and validated.

Constants

ACCOUNT_KEYS 🔒

AREAS

The sub-nav’s areas, in the order it draws them. [browser] rides with the server that hosts it; [dictate] and [tts] share the voice area, because they are the two directions of one conversation.

BOOLEAN 🔒

CLIENT_KEYS 🔒

CONNECTOR_KEYS 🔒

DICTATE_BINDS 🔒

DICTATE_CONTEXTS 🔒

DICTATE_KEYS 🔒

DICTATE_MODES 🔒

DICTATE_STRUCTURES 🔒

DICTATE_STYLINGS 🔒

DOCUMENT_KEYS 🔒

ENV_KEYS 🔒

GATEWAY_KEYS 🔒

HANDOFF_KEYS 🔒

LIST 🔒

MODEL_KEYS 🔒

NUMBER 🔒

PERMISSION_MODES 🔒

PROJECT_KEYS 🔒

PROVIDERS 🔒

SERVER_KEYS 🔒

SESSION_KEYS 🔒

TERMINAL_KEYS 🔒

TEXT 🔒

TTS_KEYS 🔒

The speaking role’s keys: the other direction of the same voice area.

USAGE_KEYS 🔒

Functions

all_keys 🔒

catalogue_target 🔒

The catalogue entry a pattern names, or None when it is not a key the loader accepts.

changed_paths 🔒

choice 🔒

diff 🔒

The reload summary, derived from the same rows the page draws: a key reported as moved and the class the page chips it with are one table’s.

document 🔒

The whole document for one load, every catalogued key resolved.

edit_kind_name 🔒

The name of a value’s edit control, as the index states its type.

edit_spec 🔒

The control and the entry a catalogued key belongs to. The default is a plain text field; a numeric, boolean, list or choice key is named here, and a test holds each edit kind to the value kind the resolver draws.

edit_wire 🔒

enum_name 🔒

flag 🔒

index_instances 🔒

The instance names a repeated catalogue key takes, for the caller’s own reach: its project’s keys list its project alone, and the global accounts, workspaces and models list every one this config declares.

index_row_in_reach 🔒

Whether a row is one the caller’s reach covers: its own project’s rows and its own org’s, so another project’s set key does not mark the caller’s index as set.

index_text 🔒

The compact catalogue an agent reads: sections and keys with type, whether the config sets one, and when an edit lands. No value crosses, so this is the shape of the file without its contents.

index_value_set 🔒

Whether a row’s value is one the reader would act on. The resolvers draw “not set” for an unset optional that has no row of its own (a model’s window), so that placeholder is not a setting either.

instance 🔒

The longest of names the path names after prefix, and the key tail that follows it.

instances_exist 🔒

Whether the instance names a pattern took all exist in config.

key_leaf 🔒

The key’s own name from a tail that may start with a repeated table: model_slugs.glm-5.3-flash names the slug, not the table.

last_segment 🔒

list 🔒

named 🔒

number 🔒

org_names 🔒

org_project 🔒

owning_org 🔒

The org a concrete path belongs to, when it is one of the org’s own keys (orgs.<org>.browser_profile, the org’s Slack binding) rather than a project’s. A read from another org is refused by name like another project’s key is: the org’s settings shape every project in it, and the org segment is ownership even though the plan’s sentence names projects.

owning_project 🔒

The project a concrete path belongs to, when the path is one of a project’s keys. The config’s own names are matched, longest first, so a project name containing a dot stays one name.

project_path 🔒

provider_label 🔒

required 🔒

resolve_target 🔒

The target a caller’s path names for a read or a write.

sorted_keys 🔒

split_row 🔒

The instance names and the key’s own name for one row.

synthetic_key 🔒

The row a writer locates for a key the document does not carry: its pattern and path are the edit’s own, and only the fields set_key reads are populated.

target 🔒

The document row a concrete path names, or None when the path is no key this load resolves. settings__get and settings__set take a path exactly as the row states it - never a catalogue pattern, which has no value and no instance to write.

text 🔒

text_set 🔒

An optional setting’s raw value: the value when the file set it, and null when it did not. The effective built-in is the page’s to draw, so the client’s axes path never reads a display default back as a setting.